name: VectorComplexFloat : public MVector<ComplexFloat, complexfloat>

synopsis:

g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_math_vector.a

#include <VectorComplexFloat.h>

VectorComplexFloat(long length = DEF_LENGTH, complexfloat value = DEF_VALUE);
VectorComplexFloat(const VectorComplexFloat& vector);

quick start:

VectorComplexFloat val0(5);

complexfloat mean;
complexfloat variance;
val0.assign(L"1-1j, 2-2j, -3+3j, -4-4j, 5j");

mean = val0.mean();

if (mean != 3) {
  Error::handle(val0.name(), L"mean", Error::TEST, __FILE__, __LINE__);
  Integral::exit();
}

variance = val0.var();

description:

The VectorComplexFloat class manages a vector of ComplexFloat objects. It is derived from the MVector class and inherits the commonly used mathematical, logical, DSP and I/O methods from it.

dependencies:

MVector

public constants:

define the class name:

static const String CLASS_NAME = L"VectorComplexFloat";

error codes:

error code indicating VectorComplexFloat class general error:
```
static const long ERR = 23000;
```

protected data:

static memory manager:
```
static MemoryManager mgr_d;
```

required public methods:

static methods:

static const String& name();

static boolean diagnose(Integral::DEBUG debug_level);

debug methods: the setDebug method is inherited from the MVector template class
```
boolean debug(const unichar* message) const;
```

destructor/constructor(s):

~VectorComplexFloat();

VectorComplexFloat(long length = DEF_LENGTH, complexfloat value = DEF_VALUE );

VectorComplexFloat(const VectorComplexFloat& vector);

assign methods: assign methods are inherited from the MVector
class

operator= methods:

VectorComplexFloat& operator= (const VectorComplexFloat& vector);

i/o methods: the sofSize, readData and writeData methods are inherited from the MVector class

boolean read(Sof& sof, long tag, const String& name = CLASS_NAME);

boolean write(Sof& sof, long tag, const String& name = CLASS_NAME);

equality methods: these methods are inherited from the MVector
class

memory management methods:

static void* operator new(size_t size);

static void* operator new[](size_t size);

static void operator delete(void* ptr);

static void operator delete[](void* ptr);

static boolean setGrowSize(long grow_size);

class-specific public methods:

constructors:

VectorComplexFloat(const String& arg, unichar delim_a = DEF_DELIM);

VectorComplexFloat(const unichar* arg, unichar delim_a = DEF_DELIM);

operator overload methods:

VectorComplexFloat& operator= (complexfloat value);

extraction methods: these methods extract components of a complex number

boolean real(VectorFloat& arg) const;

boolean imag(VectorFloat& arg) const;

boolean mag(VectorFloat& arg) const;

boolean angle(VectorFloat& arg) const;

boolean conjugate(const VectorComplexFloat& arg);

boolean conjugate();

private methods:

none.

examples:

This example shows how to write a VectorComplexFloat object into an Sof file:

VectorComplexFloat val0(3);
val0.assign(L"5+5j, 7-7j, -9+9j");
String tmp_filename(L"foo");
Sof tmp_file;
tmp_file.open(tmp_filename, File::WRITE_ONLY, File::TEXT);
       
val0.write(tmp_file, (long)0);
tmp_file.close();

This example shows how to get the norm and dot product:

VectorComplexFloat val0;
VectorComplexFloat val1(complexfloat(4, 3));
      
complexfloat dotp;
complexfloat norm_val;
       
val0.assign(L"+1+1j, 3+3j, 5j, +7-7j");
val1.assign(L"-2-2j, 4-4j, -6j, -3+3j");

dotp = val0.dotProduct(val1);
norm_val = val1.norm();

notes:

See MVector notes.