name: VectorUshort : public MVector<Ushort, ushort>

synopsis:

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

#include <VectorUshort.h>

VectorUshort(long length = DEF_LENGTH, ushort value = DEF_VALUE);
VectorUshort(const VectorUshort& vector);

quick start:

VectorUshort val0(5);

ushort mean;
ushort variance;
val0.assign(L"1, 2, 3, 4, 5");

mean = val0.mean();

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

variance = val0.var();

description:

The VectorUshort class manages a vector of Ushort objects. It is derived from the MVector class and inherits the commonly-used mathematical, logical, DSP and i/o methods from it. A VectorUshort object can read itself from (or write itself to) a Sof file. It includes the memory management methods which use the MemoryManager class to allocate or delete memory.

dependencies:

MVector

public constants:

define the class name:

static const String CLASS_NAME = L"VectorUshort";

error codes:

error code indicating VectorUshort class general error:
```
static const long ERR = 22200;
```

protected data:

define 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):

~VectorUshort();

VectorUshort(long length = DEF_LENGTH, ushort value = DEF_VALUE );

VectorUshort(const VectorUshort& vector);

assign methods:

assign methods are inherited from the MVector class

operator= methods:

VectorUshort& operator= (const VectorUshort& vector);

i/o methods: the sofSize, readData and writeData methods are inherited from the MVector template 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:

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

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

operator overload methods:
```
VectorUshort& operator= (ushort value);
```

private methods:

none

examples:

This example shows how to write a VectorUshort object into a Sof file

VectorUshort val0(3);
val0.assign(L"5, 7, 9");
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

VectorUshort val0;
VectorUshort val1(4);
       
ushort dotp;
ushort norm_val;
       
val0.assign(L"1, 3, 5, 7");
val1.assign(L"2, 4, 6, 3");

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

notes:

See the MVector notes section.