CLAM::Array< T > Class Template Reference

#include <Array.hxx>

Inheritance diagram for CLAM::Array< T >:

CLAM::Component CLAM::IndexArray

List of all members.

Detailed Description

template<class T>
class CLAM::Array< T >

Definition at line 49 of file Array.hxx.


Public Member Functions

 Array (TSize size=0, TSize step=1)
void Init ()
 Array (T *ptr, int size=0)
 Array (const Array< T > &originalArray)
 ~Array ()
const char * GetClassName () const
 Return the class name.
bool OwnsMemory () const
bool Empty () const
TSize Size (void) const
TSize SizeInBytes (void) const
TSize AllocatedSize (void) const
TSize AllocatedSizeInBytes (void) const
void SetSize (TSize size)
void SetStep (TSize step)
TSize GetStep () const
void Resize (TSize newAllocSize)
const T * GetPtr (void) const
T * GetPtr (void)
void SetPtr (T *ptr, int size=0)
void GiveChunk (int pos, int size, Array< T > &) const
void CopyChunk (int pos, int size, Array< T > &) const
const T & operator[] (const int &i) const
T & operator[] (const int &i)
void AddElem (const T &elem)
void InsertElem (int where, const T &elem)
void DeleteElem (int where)
Array< T > & operator= (const Array< T > &src)
Array< T > & operator+= (const Array< T > &src)
void Apply (T(*f)(T))
void Apply (T(*f)(T, int), int parameter)
void StoreOn (Storage &storage) const
 Stores component's subitems on the given Storage.
void LoadFrom (Storage &storage)
 Loads component's subitems from the given Storage.

Static Public Attributes

static const char * msgSetSizeOutOfRange
static const char * msgIndexOutOfRange
static const char * msgInsertOutOfRange
static const char * msgDeleteOutOfRange

Constructor & Destructor Documentation

template<class T>
CLAM::Array< T >::Array ( TSize  size = 0,
TSize  step = 1 
) [inline]

Definition at line 57 of file Array.hxx.

template<class T>
CLAM::Array< T >::Array ( T *  ptr,
int  size = 0 
) [inline]

Definition at line 70 of file Array.hxx.

template<class T>
CLAM::Array< T >::Array ( const Array< T > &  originalArray  )  [inline]

Definition at line 80 of file Array.hxx.

template<class T>
CLAM::Array< T >::~Array (  )  [inline]

Definition at line 87 of file Array.hxx.

Member Function Documentation

template<class T>
void CLAM::Array< T >::Init (  )  [inline]

Definition at line 66 of file Array.hxx.

template<class T>
const char* CLAM::Array< T >::GetClassName (  )  const [inline, virtual]

Return the class name.

Implements CLAM::Component.

Definition at line 93 of file Array.hxx.

template<class T>
bool CLAM::Array< T >::OwnsMemory (  )  const [inline]

Definition at line 95 of file Array.hxx.

Referenced by CLAM::Array< CLAM::ComplexTmpl >::AddElem(), CLAM::Array< CLAM::ComplexTmpl >::DeleteElem(), CLAM::Array< CLAM::ComplexTmpl >::InsertElem(), CLAM::Array< CLAM::ComplexTmpl >::operator=(), CLAM::Array< CLAM::ComplexTmpl >::Resize(), CLAM::Array< CLAM::ComplexTmpl >::SetPtr(), and CLAM::Array< CLAM::ComplexTmpl >::SetSize().

template<class T>
bool CLAM::Array< T >::Empty (  )  const [inline]

Definition at line 96 of file Array.hxx.

template<class T>
TSize CLAM::Array< T >::Size ( void   )  const [inline]

Definition at line 98 of file Array.hxx.

Referenced by CLAM::Add(), CLAM::CircularBuffer< float >::Add(), CLAM::AssertProperSize(), CLAM::BPFTmpl< TX, TY >::BPFTmpl(), CLAM::Complex2LogMagPhase(), CLAM::Complex2MagPhase(), CLAM::LPC_AutoCorrelation::ComputeAutocorrelation(), CLAM::ConvertToBPF(), CLAM::FundFreqDetect::Do(), CLAM::FillBuffer(), CLAM::MIDI2Melody::FindNote(), CLAM::StatsTmpl< abs >::GetCenterOfGravities(), CLAM::StatsTmpl< abs >::GetCentralMoments(), CLAM::SpectralPeakArray::GetFirstNonValidIndexPosition(), CLAM::StatsTmpl< abs >::GetMoments(), CLAM::SpectralPeakArray::GetnIndexedPeaks(), CLAM::SpectralPeakArray::GetPositionFromIndex(), CLAM::Linear2LogMagnitude(), CLAM::Log2LinearMagnitude(), CLAM::Multiply(), CLAM::ComplexMaxElement< abs, CLAM::FrameDescriptors >::operator()(), CLAM::ComplexMinElement< abs, CLAM::FrameDescriptors >::operator()(), CLAM::CentralMoment< 4, abs, float, float >::operator()(), CLAM::BiasedPoweredSum< o, abs, T, U >::operator()(), CLAM::GeometricMeanTmpl< CLAM::FrameDescriptors, CLAM::FrameDescriptors >::operator()(), CLAM::CenterOfGravity< 1, abs, T, U >::operator()(), CLAM::Moment< 1, abs, CLAM::FrameDescriptors, CLAM::FrameDescriptors >::operator()(), CLAM::CrossWeightedPoweredSum< o, abs, T >::operator()(), CLAM::WeightedPoweredSum< o, abs, T >::operator()(), CLAM::InnerProductTmpl< T >::operator()(), CLAM::LogSumTmpl< CLAM::FrameDescriptors >::operator()(), CLAM::PoweredSum< o, abs, T >::operator()(), CLAM::Array< CLAM::ComplexTmpl >::operator+=(), CLAM::Array< CLAM::ComplexTmpl >::operator=(), CLAM::operator==(), CLAM::Polar2MagPhase(), CLAM::CircularBuffer< float >::Read(), CLAM::IndexArray::Reset(), CLAM::LPC_AutoCorrelation::SolveSystemByLevinsonDurbin(), and CLAM::CircularBuffer< float >::Write().

template<class T>
TSize CLAM::Array< T >::SizeInBytes ( void   )  const [inline]

Definition at line 99 of file Array.hxx.

template<class T>
TSize CLAM::Array< T >::AllocatedSize ( void   )  const [inline]

Definition at line 100 of file Array.hxx.

Referenced by CLAM::Array< CLAM::ComplexTmpl >::operator=(), CLAM::SpectralPeakArray::ResetIndices(), CLAM::Array< CLAM::ComplexTmpl >::Resize(), and CLAM::Array< CLAM::ComplexTmpl >::SetSize().

template<class T>
TSize CLAM::Array< T >::AllocatedSizeInBytes ( void   )  const [inline]

Definition at line 101 of file Array.hxx.

template<class T>
void CLAM::Array< T >::SetSize ( TSize  size  )  [inline]

Definition at line 103 of file Array.hxx.

Referenced by CLAM::Add(), CLAM::Array< CLAM::ComplexTmpl >::Array(), CLAM::AssertProperSize(), CLAM::BPFTmpl< TX, TY >::BPFTmpl(), CLAM::BPFTmpl< TX, TY >::CreateSplineTable(), CLAM::SpectralSpread::Do(), CLAM::SpectralFocus::Do(), CLAM::SpectralEnvelopeExtract::Do(), CLAM::StatsTmpl< abs >::GetCenterOfGravities(), CLAM::StatsTmpl< abs >::GetCentralMoments(), CLAM::StatsTmpl< abs >::GetMoments(), CLAM::IndexArray::IndexArray(), CLAM::Array< CLAM::ComplexTmpl >::Init(), CLAM::SpectralPeakArray::InitIndices(), CLAM::Multiply(), CLAM::SpectralPeakArray::ResetIndices(), CLAM::BPFTmpl< TX, TY >::SetIntpType(), and CLAM::LPModel::ToSpectrum().

template<class T>
void CLAM::Array< T >::SetStep ( TSize  step  )  [inline]

Definition at line 116 of file Array.hxx.

template<class T>
TSize CLAM::Array< T >::GetStep (  )  const [inline]

Definition at line 118 of file Array.hxx.

template<class T>
void CLAM::Array< T >::Resize ( TSize  newAllocSize  )  [inline]

Definition at line 120 of file Array.hxx.

Referenced by CLAM::Add(), CLAM::Array< CLAM::ComplexTmpl >::AddElem(), CLAM::Array< CLAM::ComplexTmpl >::Array(), CLAM::AssertProperSize(), CLAM::BPFTmpl< TX, TY >::CreateSplineTable(), CLAM::Array< CLAM::ComplexTmpl >::DeleteElem(), CLAM::SpectralEnvelopeExtract::Do(), CLAM::CleanTracks::Do(), CLAM::StatsTmpl< abs >::GetCenterOfGravities(), CLAM::StatsTmpl< abs >::GetCentralMoments(), CLAM::StatsTmpl< abs >::GetMoments(), CLAM::Array< CLAM::ComplexTmpl >::Init(), CLAM::SpectralPeakArray::InitIndices(), CLAM::Array< CLAM::ComplexTmpl >::InsertElem(), CLAM::Multiply(), CLAM::Array< CLAM::ComplexTmpl >::operator+=(), CLAM::Array< CLAM::ComplexTmpl >::operator=(), CLAM::SpectralPeakArray::ResetIndices(), CLAM::BPFTmpl< TX, TY >::SetIntpType(), and CLAM::LPModel::ToSpectrum().

template<class T>
const T* CLAM::Array< T >::GetPtr ( void   )  const [inline]

Definition at line 153 of file Array.hxx.

Referenced by CLAM::LPC_AutoCorrelation::ComputeAutocorrelation(), CLAM::ComplexMaxElement< abs, CLAM::FrameDescriptors >::operator()(), CLAM::ComplexMinElement< abs, CLAM::FrameDescriptors >::operator()(), CLAM::BiasedPoweredSum< o, abs, T, U >::operator()(), CLAM::CrossWeightedPoweredSum< o, abs, T >::operator()(), CLAM::WeightedPoweredSum< o, abs, T >::operator()(), CLAM::InnerProductTmpl< T >::operator()(), CLAM::LogSumTmpl< CLAM::FrameDescriptors >::operator()(), CLAM::PoweredSum< o, abs, T >::operator()(), CLAM::Array< CLAM::ComplexTmpl >::operator=(), CLAM::CircularBuffer< float >::Read(), CLAM::IndexArray::Reset(), and CLAM::CircularBuffer< float >::Write().

template<class T>
T* CLAM::Array< T >::GetPtr ( void   )  [inline]

Definition at line 154 of file Array.hxx.

template<class T>
void CLAM::Array< T >::SetPtr ( T *  ptr,
int  size = 0 
) [inline]

Definition at line 156 of file Array.hxx.

Referenced by CLAM::Array< T >::GiveChunk(), and CLAM::CircularBuffer< float >::NonCopyRead().

template<class T>
void CLAM::Array< T >::GiveChunk ( int  pos,
int  size,
Array< T > &  a 
) const [inline]

Definition at line 406 of file Array.hxx.

References CLAM_ASSERT, and CLAM::Array< T >::SetPtr().

template<class T>
void CLAM::Array< T >::CopyChunk ( int  pos,
int  size,
Array< T > &  a 
) const [inline]

Definition at line 414 of file Array.hxx.

References CLAM_ASSERT, CLAM::Array< T >::mpData, and CLAM::Array< T >::mSize.

template<class T>
const T& CLAM::Array< T >::operator[] ( const int &  i  )  const [inline]

Definition at line 175 of file Array.hxx.

template<class T>
T& CLAM::Array< T >::operator[] ( const int &  i  )  [inline]

Definition at line 182 of file Array.hxx.

template<class T>
void CLAM::Array< T >::AddElem ( const T &  elem  )  [inline]

Definition at line 189 of file Array.hxx.

Referenced by CLAM::MIDI2Melody::AddNote(), CLAM::ConvertToArray(), CLAM::SpectralSpread::Do(), CLAM::SpectralFocus::Do(), and CLAM::CleanTracks::Do().

template<class T>
void CLAM::Array< T >::InsertElem ( int  where,
const T &  elem 
) [inline]

Definition at line 198 of file Array.hxx.

template<class T>
void CLAM::Array< T >::DeleteElem ( int  where  )  [inline]

Definition at line 209 of file Array.hxx.

Referenced by CLAM::MIDI2Melody::DeleteNoteFromIndex().

template<class T>
Array<T>& CLAM::Array< T >::operator= ( const Array< T > &  src  )  [inline]

Definition at line 221 of file Array.hxx.

template<class T>
Array<T>& CLAM::Array< T >::operator+= ( const Array< T > &  src  )  [inline]

Definition at line 251 of file Array.hxx.

template<class T>
void CLAM::Array< T >::Apply ( T(*)(T)  f  )  [inline]

Definition at line 261 of file Array.hxx.

template<class T>
void CLAM::Array< T >::Apply ( T(*)(T, int)  f,
int  parameter 
) [inline]

Definition at line 268 of file Array.hxx.

template<class T>
void CLAM::Array< T >::StoreOn ( Storage &  storage  )  const [inline, virtual]

Stores component's subitems on the given Storage.

Parameters:
storage The given storage where the subitem will be stored
See also:
Storage

Implements CLAM::Component.

Definition at line 275 of file Array.hxx.

template<class T>
void CLAM::Array< T >::LoadFrom ( Storage &  storage  )  [inline, virtual]

Loads component's subitems from the given Storage.

Parameters:
storage The given storage where the subitem will be loaded from
See also:
Storage

Implements CLAM::Component.

Definition at line 279 of file Array.hxx.

Member Data Documentation

template<class T>
const char * CLAM::Array< T >::msgSetSizeOutOfRange [inline, static]

Initial value:

"Array::SetSize(): Argument larger than allocated size\n"
"You can probably fix this calling Resize() befor SetSize()."

Definition at line 286 of file Array.hxx.

Referenced by CLAM::Array< CLAM::ComplexTmpl >::SetSize().

template<class T>
const char * CLAM::Array< T >::msgIndexOutOfRange [inline, static]

Initial value:

"Array::operator[]: Index out of range\n"
"This may happen if you forgot to call SetSize(...) in your code.\n"
"This is now needed. Just calling Resize() is not enough any more."

Definition at line 287 of file Array.hxx.

Referenced by CLAM::Array< CLAM::ComplexTmpl >::operator[]().

template<class T>
const char * CLAM::Array< T >::msgInsertOutOfRange [inline, static]

Initial value:

 
"Array::InsertElem: Index out of range"

Definition at line 288 of file Array.hxx.

Referenced by CLAM::Array< CLAM::ComplexTmpl >::InsertElem().

template<class T>
const char * CLAM::Array< T >::msgDeleteOutOfRange [inline, static]

Initial value:

 
"Array::DeleteElem: Index out of range"

Definition at line 289 of file Array.hxx.

Referenced by CLAM::Array< CLAM::ComplexTmpl >::DeleteElem().

The documentation for this class was generated from the following file:
Generated on Tue Aug 12 22:33:50 2008 for CLAM by  doxygen 1.5.5