#include <klang.h>

Inheritance diagram for klang::Generic::Graph< SIZE >::Series:

Public Types
using	Array = Array<Point, SIZE + 1>

Public Member Functions
virtual	~Series ()

void	add (double y)

template<typename SIGNAL , typename... Args>
void	plot (Generic::Function< SIGNAL, Args... > &f, const Axis &x_axis)

template<typename RETURN , typename ARG >
void	plot (RETURN(*f)(ARG), const Axis &x_axis)

bool	operator== (const Series &in) const

bool	operator!= (const Series &in) const

void	clear ()

void	input () override

virtual const SIGNAL &	input () const

virtual void	input (const SIGNAL &source)

unsigned int	size () const
	The current number of items in the array.

void	add (const Point &item)
	Add the specified item to the end of the array.

Point *	add ()
	Add a blank item to the end of the array, returning a pointer that allows the item to be modified.

float	max () const
	Find the maximum value in the array.

float	mean () const
	Find the mean average of values in the array.

float	rms () const
	Find the root mean squared (RMS) average of values in the array.

void	normalise (float target=1.f, int mode=Peak)
	Normalises values in the array to the specified target, based on peak, mean, or RMS value;.

Point &	operator[] (int index)
	Returns a reference to the array item at the given index.

const Point &	operator[] (int index) const
	Returns a read-only reference to the array item at the given index.

virtual void	input (const signal &source)

virtual void	operator<< (const signal &source)

Static Public Member Functions
static int	capacity ()
	The maximum capacity of the array.

Public Attributes
void *	function = nullptr

uint64_t	hash = 0

Point	items [CAPACITY]

unsigned int	count

signal	in

Detailed Description

template<int SIZE>
struct klang::Generic::Graph< SIZE >::Series

Definition at line 1652 of file klang.h.

Member Typedef Documentation

◆ Array

template<int SIZE>

using klang::Generic::Graph< SIZE >::Series::Array = Array<Point, SIZE + 1>

Definition at line 1658 of file klang.h.

Constructor & Destructor Documentation

◆ ~Series()

template<int SIZE>

virtual klang::Generic::Graph< SIZE >::Series::~Series ( )

inlinevirtual

Definition at line 1653 of file klang.h.

1653{ }

Member Function Documentation

◆ add() [1/3]

Point * klang::Array< Point, CAPACITY >::add ( )

inlineinherited

Definition at line 255 of file klang.h.

                {
      if (count < CAPACITY)
        return &items[count++];
      return nullptr;
    }

◆ add() [2/3]

void klang::Array< Point, CAPACITY >::add ( const Point & item )

inlineinherited

Definition at line 249 of file klang.h.

                               {
      if(count < CAPACITY)
        items[count++] = item;
    }

◆ add() [3/3]

template<int SIZE>

void klang::Generic::Graph< SIZE >::Series::add ( double y )

inline

Definition at line 1663 of file klang.h.

                           {
          add({ (double)Array::size(), y });
        }

◆ capacity()

static int klang::Array< Point, CAPACITY >::capacity ( )

inlinestaticinherited

Definition at line 243 of file klang.h.

243{ return CAPACITY; }

◆ clear()

template<int SIZE>

void klang::Generic::Graph< SIZE >::Series::clear ( )

inline

Definition at line 1713 of file klang.h.

                     {
          function = nullptr;
          Array::clear();
        }

References klang::Generic::Graph< SIZE >::Series::function.

◆ input() [1/4]

template<int SIZE>

virtual const SIGNAL & klang::Generic::Input< SIGNAL >::input ( ) const

inlinevirtual

Reimplemented from klang::Generic::Input< signal >.

Definition at line 1343 of file klang.h.

1343{ return in; }

klang::Generic::Input< signal >::in

signal in

Definition klang.h:1340

◆ input() [2/4]

template<int SIZE>

void klang::Generic::Graph< SIZE >::Series::input ( )

inlineoverridevirtual

Reimplemented from klang::Generic::Input< signal >.

Definition at line 1719 of file klang.h.

                              {
          add(in);
        }

◆ input() [3/4]

template<int SIZE>

virtual void klang::Generic::Input< SIGNAL >::input ( const SIGNAL & source )

inline

Definition at line 1347 of file klang.h.

1347{ in = source; input(); }

klang::Generic::Graph::Series::input

void input() override

Definition klang.h:1719

◆ input() [4/4]

virtual void klang::Generic::Input< signal >::input ( const signal & source )

inlinevirtualinherited

Definition at line 1347 of file klang.h.

1347{ in = source; input(); }

klang::Generic::Input< signal >::input

virtual const signal & input() const

Definition klang.h:1343

◆ max()

float klang::Array< Point, CAPACITY >::max ( ) const

inlineinherited

Definition at line 265 of file klang.h.

                      {
      float max = 0.f;
      for (unsigned int i = 0; i < count; i++)
        if (abs(items[i]) > max)
          max = items[i];
      return max;
    }

◆ mean()

float klang::Array< Point, CAPACITY >::mean ( ) const

inlineinherited

Definition at line 274 of file klang.h.

                       {
      float sum = 0.f;
      for (unsigned int i = 0; i < count; i++)
        sum += abs(items[i]);
      return sum / count;
    }

◆ normalise()

void klang::Array< Point, CAPACITY >::normalise	(	float	target = 1.f,
		int	mode = Peak )

inlineinherited

Definition at line 290 of file klang.h.

                                                        {
      if (!count) return;
      
      const float current = (mode == Peak) ? max() : (mode == Mean) ? mean() : rms();
      const float scale = current == 0.f ? 0.f : target / current;
      for (int i = 0; i < count; i++)
        items[i] *= scale;
    }

◆ operator!=()

template<int SIZE>

bool klang::Generic::Graph< SIZE >::Series::operator!= ( const Series & in ) const

inline

Definition at line 1709 of file klang.h.

                                                {
          return !operator==(in);
        }

◆ operator<<()

virtual void klang::Generic::Input< signal >::operator<< ( const signal & source )

inlinevirtualinherited

Definition at line 1346 of file klang.h.

1346{ in = source; input(); }

◆ operator==()

template<int SIZE>

bool klang::Generic::Graph< SIZE >::Series::operator== ( const Series & in ) const

inline

Definition at line 1701 of file klang.h.

                                                {
          if (count != in.count) return false;
          for (unsigned int i = 0; i < count; i++)
            if (items[i].x != in.items[i].x || items[i].y != in.items[i].y)
              return false;
          return true;
        }

◆ operator[]() [1/2]

Point & klang::Array< Point, CAPACITY >::operator[] ( int index )

inlineinherited

Definition at line 300 of file klang.h.

300{ return items[index]; }

◆ operator[]() [2/2]

const Point & klang::Array< Point, CAPACITY >::operator[] ( int index ) const

inlineinherited

Definition at line 303 of file klang.h.

303{ return items[index]; }

◆ plot() [1/2]

template<int SIZE>

template<typename SIGNAL , typename... Args>

void klang::Generic::Graph< SIZE >::Series::plot	(	Generic::Function< SIGNAL, Args... > &	f,
		const Axis &	x_axis )

inline

Definition at line 1668 of file klang.h.

                                                                           {
          constexpr int size = SIZE > 1024 ? 1024 : SIZE;
 
          if (function != (void*)f || hash != f.hash()) {
            clear();
            function = (void*)f;
            hash = f.hash();
            double x = 0;
            const double dx = x_axis.range() / size;
            for (int i = 0; i <= size; i++) {
              x = x_axis.min + i * dx;
              add({ x, (double)(signal)f(x) });
            }
          }
        }

◆ plot() [2/2]

template<int SIZE>

template<typename RETURN , typename ARG >

void klang::Generic::Graph< SIZE >::Series::plot	(	RETURN(*	f )(ARG),
		const Axis &	x_axis )

inline

Definition at line 1685 of file klang.h.

                                                       {
          constexpr int size = SIZE > 1024 ? 1024 : SIZE;
 
          if (function != (void*)f) {
            clear();
            function = (void*)f;
            hash = 0;
            double x = 0;
            const double dx = x_axis.range() / size;
            for (int i = 0; i <= size; i++) {
              x = x_axis.min + i * dx;
              add({ x, (double)(signal)f((float)x) });
            }
          }
        }

◆ rms()

float klang::Array< Point, CAPACITY >::rms ( ) const

inlineinherited

Definition at line 282 of file klang.h.

                      {
      float sum = 0.f;
      for (unsigned int i = 0; i < count; i++)
        sum += items[i] * items[i];
      return sqrt(sum / count);
    }

◆ size()

unsigned int klang::Array< Point, CAPACITY >::size ( ) const

inlineinherited

Definition at line 246 of file klang.h.

246{ return count; }

Member Data Documentation

◆ count

unsigned int klang::Array< Point, CAPACITY >::count

inherited

Definition at line 240 of file klang.h.

◆ function

template<int SIZE>

void* klang::Generic::Graph< SIZE >::Series::function = nullptr

Definition at line 1655 of file klang.h.

Referenced by klang::Generic::Graph< SIZE >::Series::clear().

◆ hash

template<int SIZE>

uint64_t klang::Generic::Graph< SIZE >::Series::hash = 0

Definition at line 1656 of file klang.h.

◆ in

signal klang::Generic::Input< signal >::in

inherited

Definition at line 1340 of file klang.h.

1340{ 0.f };

◆ items

Point klang::Array< Point, CAPACITY >::items[CAPACITY]

inherited

Definition at line 239 of file klang.h.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ Array

Constructor & Destructor Documentation

◆ ~Series()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ capacity()

◆ clear()

◆ input() [1/4]

◆ input() [2/4]

◆ input() [3/4]

◆ input() [4/4]

◆ max()

◆ mean()

◆ normalise()

◆ operator!=()

◆ operator<<()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ plot() [1/2]

◆ plot() [2/2]

◆ rms()

◆ size()

Member Data Documentation

◆ count

◆ function

◆ hash

◆ in

◆ items