CARMA C++
carma::util::WalshFunction Class Reference

Class to generate and manipulate Walsh functions. More...

#include <carma/util/WalshFunction.h>

Public Member Functions

void dump (bool whitespace=true) const
 Dump the values to stdout. More...
 
bool getValue (int function, int value) const
 Get value. More...
 
void graph () const
 Graph the values to stdout, looks like __–__–. More...
 
 WalshFunction (int nStates)
 Constructor, generates a WalshSequence number of states in the sequence Must be a power of two; not to exceed 256. More...
 
virtual ~WalshFunction ()
 Destructor. More...
 

Detailed Description

Class to generate and manipulate Walsh functions.

Walsh Functions: The reference used is Applications of Walsh and Related Functions, by K.G. Beauchamp. We generate Walsh functions from the difference equation, cf p. 20.

Definition at line 35 of file WalshFunction.h.

Constructor & Destructor Documentation

carma::util::WalshFunction::WalshFunction ( int  nStates)

Constructor, generates a WalshSequence number of states in the sequence Must be a power of two; not to exceed 256.

Exceptions
ErrorExceptionwhen rows are not power of two
virtual carma::util::WalshFunction::~WalshFunction ( )
virtual

Destructor.

Member Function Documentation

void carma::util::WalshFunction::dump ( bool  whitespace = true) const

Dump the values to stdout.

Parameters
whitespace- put a blank character in between values
bool carma::util::WalshFunction::getValue ( int  function,
int  value 
) const

Get value.

Parameters
functionWalsh function number (start at 0)
indexof value within the function (start at 0)
Exceptions
ErrorExceptionif function or index is out of range
void carma::util::WalshFunction::graph ( ) const

Graph the values to stdout, looks like __–__–.


The documentation for this class was generated from the following file: