klang::Table< TYPE, SIZE >

Lookup table object. More...

#include <klang.h>

Inheritance diagram for klang::Table< TYPE, SIZE >:

Public Types
typedef Array< TYPE, SIZE >	Array
typedef Result< TYPE >	Result

Public Member Functions
	Table (TYPE(*function)(TYPE))
	Table (void(*function)(TYPE, TYPE), TYPE arg)
	Table (void(*function)(TYPE x, Result &y))
	Table (std::initializer_list< TYPE > values)
TYPE	operator[] (float index)
unsigned int	size () const
	The current number of items in the array.
void	add (const TYPE &item)
	Add the specified item to the end of the array.
TYPE *	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;.
TYPE &	operator[] (int index)
	Returns a reference to the array item at the given index.
const TYPE &	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
TYPE	items [CAPACITY]
unsigned int	count

Detailed Description

template<typename TYPE, int SIZE>
struct klang::Table< TYPE, SIZE >

Definition at line 2429 of file klang.h.

Member Typedef Documentation

Array

template<typename TYPE , int SIZE>

Array<TYPE, SIZE> klang::Table< TYPE, SIZE >::Array

Definition at line 2430 of file klang.h.

Result

template<typename TYPE , int SIZE>

Result<TYPE> klang::Table< TYPE, SIZE >::Result

Definition at line 2431 of file klang.h.

Constructor & Destructor Documentation

Table() [1/4]

template<typename TYPE , int SIZE>

klang::Table< TYPE, SIZE >::Table ( TYPE(* function )(TYPE) )

inline

Definition at line 2436 of file klang.h.

                                 {
      for (int x = 0; x < SIZE; x++)
        add(function(x));
    }

Table() [2/4]

template<typename TYPE , int SIZE>

klang::Table< TYPE, SIZE >::Table ( void(* function )(TYPE, TYPE), TYPE arg )

inline

Definition at line 2442 of file klang.h.

                                                 {
      Array::count = SIZE;
      for (int x = 0; x < SIZE; x++)
        Array::items[x] = function(x, arg);
    }

Table() [3/4]

template<typename TYPE , int SIZE>

klang::Table< TYPE, SIZE >::Table ( void(* function )(TYPE x, Result &y) )

inline

Definition at line 2449 of file klang.h.

                                              {
      Array::count = SIZE;
      Result y(Array::items, 0);
      for (int x = 0; x < SIZE; x++) {
        function((TYPE)x, y);
        y.sum += Array::items[x];
        y++;
      }
    }

Table() [4/4]

template<typename TYPE , int SIZE>

klang::Table< TYPE, SIZE >::Table ( std::initializer_list< TYPE > values )

inline

Definition at line 2459 of file klang.h.

                                            {
      for (TYPE value : values)
        add(value);
    }

Member Function Documentation

add() [1/2]

TYPE * klang::Array< TYPE, 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< TYPE, CAPACITY >::add ( const TYPE & item )

inlineinherited

Definition at line 249 of file klang.h.

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

capacity()

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

inlinestaticinherited

Definition at line 243 of file klang.h.

{ return CAPACITY; }

clear()

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

inlineinherited

Definition at line 262 of file klang.h.

{ count = 0; }

max()

float klang::Array< TYPE, 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< TYPE, 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< TYPE, 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/3]

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

inlineinherited

Definition at line 300 of file klang.h.

{ return items[index]; }

operator[]() [2/3]

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

inlineinherited

Definition at line 303 of file klang.h.

{ return items[index]; }

operator[]() [3/3]

template<typename TYPE , int SIZE>

TYPE klang::Table< TYPE, SIZE >::operator[] ( float index )

inline

Definition at line 2465 of file klang.h.

                                 {
      if (index < 0) return Array::items[0];
      else if (index >= (SIZE - 1)) return Array::items[SIZE - 1];
      else {
        const float x = std::floor(index);
        const int i = int(x);
        const float dx = index - x;
        const float dy = Array::items[i + 1] - Array::items[i];
        return Array::items[i] + dx * dy;
      }
    }

rms()

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

inlineinherited

Definition at line 246 of file klang.h.

{ return count; }

Member Data Documentation

count

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

inherited

Definition at line 240 of file klang.h.

items

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

inherited

Definition at line 239 of file klang.h.