Nsound::Kernel Class Reference

#include <Nsound/Kernel.h>

Public Member Functions
	Kernel (uint32 b_length, uint32 a_length, int32 f1=0, int32 f2=0, int32 f3=0, int32 f4=0)
	Kernel (const Kernel &copy)
virtual	~Kernel ()
boolean	operator< (const Kernel &rhs) const
float64	getA (uint32 i)
	Returns kernel 'a[i]' coef. More...
float64 *	getA ()
	Returns Kernel 'a' array, the length is returned by getALegnth() More...
const float64 *	getA () const
	Returns Kernel 'a' array, the length is returned by getALegnth() More...
float64	getB (uint32 i)
	Returns kernel 'b[i]' coef. More...
float64 *	getB ()
	Returns kernel 'b' array, the length is returned by getBLegnth() More...
const float64 *	getB () const
	Returns kernel 'b' array, the length is returned by getBLegnth() More...
uint32	getALength () const
uint32	getBLength () const
float64	getSum () const
Kernel &	operator= (const Kernel &rhs)
void	randomize (const float64 &min=-1.0, const float64 &max=1.0)
	Sets all coefs to random float64 values between min & max. More...
void	setA (const float64 *a)
	Copy getALength() values from the array a into the Kernel. Use setLength() to set the number of values to copy. More...
void	setA (const float64 &d, uint32 i)
	Set a_[i] = d. More...
void	setA (const Buffer &a)
	Copy getALength() values from the array a into the Kernel. Use setLength() to set the number of values to copy. More...
void	setB (const float64 *b)
	Copy getBLength() values from the array a into the Kernel. Use setLength() to set the number of values to copy. More...
void	setB (const float64 &d, uint32 i)
	Set b_[i] = d. More...
void	setB (const Buffer &b)
	Copy getALength() values from the array a into the Kernel. Use setLength() to set the number of values to copy. More...
void	setLength (uint32 b_length, uint32 a_length)
void	ga_swap_ab (Kernel &rhs)
	Genitic Algorithm Helper Function: swaps the A & B coefs. More...
void	ga_interleave (Kernel &rhs)
	Genitic Algorithm Helper Function: interleave B coefs with B, A with A. More...
void	ga_interleave ()
	Genitic Algorithm Helper Function: interleave B coefs with A. More...

Protected Attributes
uint32	b_length_
uint32	a_length_
int32	f1_
int32	f2_
int32	f3_
int32	f4_
float64 *	b_
float64 *	a_

Friends
std::ostream &	operator<< (std::ostream &out, const Kernel &rhs)
	Prints the coeffents. More...

Detailed Description

WARNING: This is Experimental, you should not use this class as it may not be working or will change in future releases of Nsound.

Definition at line 50 of file Kernel.h.

Constructor & Destructor Documentation

Kernel::Kernel	(	uint32	b_length,
		uint32	a_length,
		int32	f1 = 0,
		int32	f2 = 0,
		int32	f3 = 0,
		int32	f4 = 0
	)

Definition at line 48 of file Kernel.cc.

References a_, and b_.

    :
    b_length_(b_length),
    a_length_(a_length),
    f1_(f1),
    f2_(f2),
    f3_(f3),
    f4_(f4),
    b_(NULL),
    a_(NULL)
{
    b_ = new float64 [b_length];
    a_ = new float64 [a_length];
}

Kernel::Kernel

(

const Kernel &

copy

)

Definition at line 69 of file Kernel.cc.

References a_, a_length_, b_, and b_length_.

    :
    b_length_(copy.b_length_),
    a_length_(copy.a_length_),
    f1_(copy.f1_),
    f2_(copy.f2_),
    f3_(copy.f3_),
    f4_(copy.f4_),
    b_(NULL),
    a_(NULL)
{
    b_ = new float64 [b_length_];
    a_ = new float64 [a_length_];

    *this = copy;
}

Kernel::~Kernel ( )

virtual

Definition at line 88 of file Kernel.cc.

References a_, and b_.

{
    delete [] b_;
    delete [] a_;
}

Member Function Documentation

boolean Kernel::operator<

(

const Kernel &

rhs

)

const

Definition at line 119 of file Kernel.cc.

References a_length_, b_length_, f1_, f2_, f3_, and f4_.

{
    return (b_length_ < rhs.b_length_)  ||

           (b_length_ == rhs.b_length_  &&
            a_length_  < rhs.a_length_) ||

           (b_length_ == rhs.b_length_  &&
            a_length_ == rhs.a_length_  &&
            f1_        < rhs.f1_)       ||

           (b_length_ == rhs.b_length_  &&
            a_length_ == rhs.a_length_  &&
            f1_       == rhs.f1_        &&
            f2_        < rhs.f2_)       ||

           (b_length_ == rhs.b_length_  &&
            a_length_ == rhs.a_length_  &&
            f1_       == rhs.f1_        &&
            f2_       == rhs.f2_        &&
            f3_        < rhs.f3_)       ||

           (b_length_ == rhs.b_length_  &&
            a_length_ == rhs.a_length_  &&
            f1_       == rhs.f1_        &&
            f2_       == rhs.f2_        &&
            f3_       == rhs.f3_        &&
            f4_        < rhs.f4_)       ||

           false;

}

float64 Nsound::Kernel::getA ( uint32  i )

inline

Returns kernel 'a[i]' coef.

Definition at line 70 of file Kernel.h.

References a_, and a_length_.

Referenced by Nsound::FilterIIR::designKernel(), Nsound::FilterIIR::filter(), and ga_swap_ab().

    { if(i < a_length_) return a_[i]; return 0.0; };

float64* Nsound::Kernel::getA ( )

inline

Returns Kernel 'a' array, the length is returned by getALegnth()

Definition at line 75 of file Kernel.h.

References a_.

Referenced by ga_swap_ab().

    { return a_; };

const float64* Nsound::Kernel::getA ( ) const

inline

Returns Kernel 'a' array, the length is returned by getALegnth()

Definition at line 81 of file Kernel.h.

References a_.

    { return a_; };

float64 Nsound::Kernel::getB ( uint32  i )

inline

Returns kernel 'b[i]' coef.

Definition at line 86 of file Kernel.h.

References b_, and b_length_.

Referenced by Nsound::FilterIIR::designKernel(), Nsound::FilterIIR::filter(), and ga_swap_ab().

    { if(i < b_length_) return b_[i]; return 0.0; };

float64* Nsound::Kernel::getB ( )

inline

Returns kernel 'b' array, the length is returned by getBLegnth()

Definition at line 91 of file Kernel.h.

References b_.

Referenced by ga_swap_ab().

    { return b_; };

const float64* Nsound::Kernel::getB ( ) const

inline

Returns kernel 'b' array, the length is returned by getBLegnth()

Definition at line 97 of file Kernel.h.

References b_.

    { return b_; };

uint32 Nsound::Kernel::getALength ( ) const

inline

Definition at line 101 of file Kernel.h.

References a_length_.

Referenced by Nsound::operator<<().

{ return a_length_; };

uint32 Nsound::Kernel::getBLength ( ) const

inline

Definition at line 104 of file Kernel.h.

References b_length_.

Referenced by Nsound::operator<<().

{ return b_length_; };

float64 Kernel::getSum

(

)

const

Definition at line 154 of file Kernel.cc.

References a_, a_length_, b_, and b_length_.

Referenced by Nsound::FilterIIR::designKernel().

{
    float64 sum = 0.0;

    for(uint32 i = 0; i < b_length_; ++i)
    {
        sum += std::fabs(b_[i]);
    }

    for(uint32 i = 0; i < a_length_; ++i)
    {
        sum += std::fabs(a_[i]);
    }

    return sum;
}

Kernel & Kernel::operator=

(

const Kernel &

rhs

)

Definition at line 97 of file Kernel.cc.

References a_, a_length_, b_, b_length_, f1_, f2_, f3_, f4_, and setLength().

{
    if(this == & rhs)
    {
        return *this;
    }

    setLength(rhs.b_length_, rhs.a_length_);

    memcpy(b_, rhs.b_, sizeof(float64) * b_length_);
    memcpy(a_, rhs.a_, sizeof(float64) * a_length_);

    f1_ = rhs.f1_;
    f2_ = rhs.f2_;
    f3_ = rhs.f3_;
    f4_ = rhs.f4_;

    return *this;
}

void Kernel::randomize	(	const float64 &	min = -1.0,
		const float64 &	max = 1.0
	)

Sets all coefs to random float64 values between min & max.

Definition at line 194 of file Kernel.cc.

References a_, a_length_, b_, b_length_, and Nsound::RngTausworthe::get().

Referenced by Nsound::FilterIIR::designKernel().

{
    RngTausworthe rng;

    for(uint32 i = 0; i < b_length_; ++i)
    {
        b_[i] = rng.get(min, max);
    }

    for(uint32 i = 0; i < a_length_; ++i)
    {
        a_[i] = rng.get(min, max);
    }
}

void Kernel::setA

(

const float64 *

a

)

Copy getALength() values from the array a into the Kernel. Use setLength() to set the number of values to copy.

Definition at line 211 of file Kernel.cc.

References a_, and a_length_.

Referenced by Nsound::FilterIIR::designKernel(), ga_swap_ab(), and Nsound::FilterParametricEqualizer::makeKernel().

{
    memcpy(a_, a, sizeof(float64) * a_length_);
}

void Nsound::Kernel::setA ( const float64 &  d, uint32  i  )

inline

Set a_[i] = d.

Definition at line 127 of file Kernel.h.

References a_, and a_length_.

    { if(i < a_length_) a_[i] = d; };

void Kernel::setA

(

const Buffer &

a

)

Copy getALength() values from the array a into the Kernel. Use setLength() to set the number of values to copy.

Definition at line 218 of file Kernel.cc.

References a_, a_length_, and Nsound::Buffer::getLength().

{
    uint32 a_len = a.getLength();

    for(uint32 i = 0; i < a_length_; ++i)
    {
        if(i < a_len)
        {
            a_[i] = a[i];
        }
    }
}

void Kernel::setB

(

const float64 *

b

)

Copy getBLength() values from the array a into the Kernel. Use setLength() to set the number of values to copy.

Definition at line 233 of file Kernel.cc.

References b_, and b_length_.

Referenced by Nsound::FilterIIR::designKernel(), ga_swap_ab(), and Nsound::FilterParametricEqualizer::makeKernel().

{
    memcpy(b_, b, sizeof(float64) * b_length_);
}

void Nsound::Kernel::setB ( const float64 &  d, uint32  i  )

inline

Set b_[i] = d.

Definition at line 140 of file Kernel.h.

References b_, and b_length_.

    { if(i < b_length_) b_[i] = d; };

void Kernel::setB

(

const Buffer &

b

)

Copy getALength() values from the array a into the Kernel. Use setLength() to set the number of values to copy.

Definition at line 240 of file Kernel.cc.

References b_, b_length_, and Nsound::Buffer::getLength().

{
    uint32 b_len = b.getLength();

    for(uint32 i = 0; i < b_length_; ++i)
    {
        if(i < b_len)
        {
            b_[i] = b[i];
        }
    }
}

void Kernel::setLength	(	uint32	b_length,
		uint32	a_length
	)

Definition at line 255 of file Kernel.cc.

References a_, a_length_, b_, and b_length_.

Referenced by operator=().

{
    if(b_length_ != b_length)
    {
        b_length_ = b_length;
        delete [] b_;
        b_ = new float64 [b_length_];
    }

    if(a_length_ != a_length)
    {
        a_length_ = a_length;
        delete [] a_;
        a_ = new float64 [a_length_];
    }

}

void Kernel::ga_swap_ab

(

Kernel &

rhs

)

Genitic Algorithm Helper Function: swaps the A & B coefs.

Definition at line 275 of file Kernel.cc.

References getA(), getB(), setA(), and setB().

Referenced by Nsound::FilterIIR::designKernel().

{
    Kernel temp(rhs);

    rhs.setA(getB());
    rhs.setB(getA());

    setA(temp.getB());
    setB(temp.getA());
}

void Kernel::ga_interleave

(

Kernel &

rhs

)

Genitic Algorithm Helper Function: interleave B coefs with B, A with A.

Definition at line 296 of file Kernel.cc.

References a_, a_length_, b_, b_length_, and swap_().

Referenced by Nsound::FilterIIR::designKernel().

{
    Kernel temp(rhs);

    for(uint32 i = 0; i < b_length_; ++i)
    {
        if(i % 2)
        {
            swap_(b_[i], rhs.b_[i]);
        }
    }

    for(uint32 i = 0; i < a_length_; ++i)
    {
        if(i % 2)
        {
            swap_(a_[i], rhs.a_[i]);
        }
    }

}

void Kernel::ga_interleave

(

)

Genitic Algorithm Helper Function: interleave B coefs with A.

Definition at line 320 of file Kernel.cc.

References a_, a_length_, b_, b_length_, and swap_().

{
    for(uint32 i = 0; i < b_length_; ++i)
    {
        if(i % 2 && i < a_length_)
        {
            swap_(b_[i], a_[i]);
        }
    }

}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out, const Kernel &  rhs  )

friend

Prints the coeffents.

Member Data Documentation

uint32 Nsound::Kernel::b_length_

protected

Definition at line 164 of file Kernel.h.

Referenced by ga_interleave(), getB(), getBLength(), getSum(), Kernel(), operator<(), Nsound::operator<<(), operator=(), randomize(), setB(), and setLength().

uint32 Nsound::Kernel::a_length_

protected

Definition at line 165 of file Kernel.h.

Referenced by ga_interleave(), getA(), getALength(), getSum(), Kernel(), operator<(), Nsound::operator<<(), operator=(), randomize(), setA(), and setLength().

int32 Nsound::Kernel::f1_

protected

Definition at line 167 of file Kernel.h.

Referenced by operator<(), and operator=().

int32 Nsound::Kernel::f2_

protected

Definition at line 168 of file Kernel.h.

Referenced by operator<(), and operator=().

int32 Nsound::Kernel::f3_

protected

Definition at line 169 of file Kernel.h.

Referenced by operator<(), and operator=().

int32 Nsound::Kernel::f4_

protected

Definition at line 170 of file Kernel.h.

Referenced by operator<(), and operator=().

float64* Nsound::Kernel::b_

protected

Definition at line 172 of file Kernel.h.

Referenced by ga_interleave(), getB(), getSum(), Kernel(), Nsound::operator<<(), operator=(), randomize(), setB(), setLength(), and ~Kernel().

float64* Nsound::Kernel::a_

protected

Definition at line 173 of file Kernel.h.

Referenced by ga_interleave(), getA(), getSum(), Kernel(), Nsound::operator<<(), operator=(), randomize(), setA(), setLength(), and ~Kernel().

---

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

• Nsound/Kernel.h
• Nsound/Kernel.cc