klang::Generic::Graph< SIZE >::Data

Graph data. More...

#include <klang.h>

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

Public Member Functions
Series *	find (void *function)
unsigned int	size () const
	The current number of items in the array.
void	add (const Series &item)
	Add the specified item to the end of the array.
Series *	add ()
	Add a blank item to the end of the array, returning a pointer that allows the item to be modified.
void	clear ()
	Clear the array contents. Only resets the item count, without wiping memory.
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;.
Series &	operator[] (int index)
	Returns a reference to the array item at the given index.
const Series &	operator[] (int index) const
	Returns a read-only reference to the array item at the given index.

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

Public Attributes
Series	items [CAPACITY]
unsigned int	count

Detailed Description

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

Definition at line 1779 of file klang.h.

Member Function Documentation

add() [1/2]

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

inlineinherited

Definition at line 255 of file klang.h.

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

add() [2/2]

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

inlineinherited

Definition at line 249 of file klang.h.

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

capacity()

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

inlinestaticinherited

Definition at line 243 of file klang.h.

{ return CAPACITY; }

clear()

void klang::Array< Series, CAPACITY >::clear ( )

inlineinherited

Definition at line 262 of file klang.h.

{ count = 0; }

find()

template<int SIZE>

Series * klang::Generic::Graph< SIZE >::Data::find ( void * function )

inline

Definition at line 1782 of file klang.h.

                                     {
          for (int s = 0; s < GRAPH_SERIES; s++)
            if (this->operator[](s).function == function)
              return &items[s];
          return nullptr;
        }

max()

float klang::Array< Series, 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< Series, 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< Series, 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[]() [1/2]

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

inlineinherited

Definition at line 300 of file klang.h.

{ return items[index]; }

operator[]() [2/2]

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

inlineinherited

Definition at line 303 of file klang.h.

{ return items[index]; }

rms()

float klang::Array< Series, 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< Series, CAPACITY >::size ( ) const

inlineinherited

Definition at line 246 of file klang.h.

{ return count; }

Member Data Documentation

count

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

inherited

Definition at line 240 of file klang.h.

items

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

inherited

Definition at line 239 of file klang.h.