Category : C++ Source Code
Archive   : JCOOL01.ZIP
Filename : M_VECTOR.H

 
Output of file : M_VECTOR.H contained in archive : JCOOL01.ZIP

//
// Copyright (C) 1991 Texas Instruments Incorporated.
// Copyright (C) 1992 General Electric Company.
//
// Permission is granted to any individual or institution to use, copy, modify,
// and distribute this software, provided that this complete copyright and
// permission notice is maintained, intact, in all copies and supporting
// documentation.
//
// Texas Instruments Incorporated, General Electric Company,
// provides this software "as is" without express or implied warranty.
//
// Created: VDN 02/21/92 -- new version adapted from Matrix.h
// Updated: JAM 08/15/92 -- removed DOS specifics, stdized #includes
// Updated: JAM 08/24/92 -- modernized template syntax, remove macro hacks
// non-template classes CoolM_Vector=>CoolBase_M_Vector
// Updated: JAM 08/24/92 -- removed references to envelope class
// Updated: JAM 08/24/92 -- made some binary member funcs friends instead
// Updated: JAM 08/24/92 -- made put()'s value a 'const' Type&
// Updated: JAM 09/26/92 -- put envelope back but using modern templates
//
// The parameterized M_Vector class is publicly derived from the M_Vector
// class and implements one dimensional arithmetic vectors of a user specified
// type. This is accompilshed by using the parameterized type capability of
// C++. The only constraint placed on the type is that it must overload the
// following operators: +, -, *, and /. Thus, it will be possible to have a
// M_Vector of type Complex. The M_Vector class is static in size, that is
// once a M_Vector of a particular size has been declared, there is no
// dynamic growth or resize method available.
//
// Each vector contains a protected data section that has a Type* slot that
// points to the physical memory allocated for the one dimensional array. In
// addition, an integer specifies the number of elements for the
// vector. These values are provided in the constructors. A single protected
// slot contains a pointer to a compare function to be used in equality
// operations. The default function used is the built-in == operator.
//
// Four different constructors are provided. The first constructor takes an
// integer arguments specifying the length. Enough memory is
// allocated to hold [length] elements of type Type. The second constructor
// takes the same first argument, but also accepts an additional second
// argument that is a reference to an object of the appropriate type whose
// value is used as an initial fill value. The third constructor is similar to
// the third, except that it accpets a variable number of initialization values
// for the M_Vector. If there are fewer values than elements, the rest are set
// to zero. Finally, the last constructor takes a single argument consisting of
// a reference to a M_Vector and duplicates its size and element values.
//
// Methods are provided for destructive scalar and vector addition,
// multiplication, check for equality and inequality, fill, reduce, and access
// and set individual elements. Finally, both the input and output operators
// are overloaded to allow for fomatted input and output of vector elements.
//
// M_Vector is a special type of matrix, and is implemented for space and time
// efficiency. When vector is pre_multiplied by/with matrix, m*v, vector is
// implicitly a column matrix. When vector is post_multiplied by/with matrix, v*m,
// vector is implicitly a row matrix.
//

#ifndef M_VECTORH // If no M_Vector class,
#define M_VECTORH // define it

#ifndef STDARGH
#include // for variable arglists
#define STDARGH
#endif

#ifndef MATHH
#include // for sqrt
#define MATHH
#endif

#ifndef BASE_M_VECTORH // If no base class definition
#include // include it
#endif

#include

//## hack to workaround BC++ 3.1 Envelope bug
#undef CoolEnvelope_H
#define CoolEnvelope CoolEnvelope_M_Vector

template class CoolEnvelope;

template
class CoolM_Vector : public CoolBase_M_Vector {
public:
CoolM_Vector(unsigned int len=1); // v (n);
CoolM_Vector(unsigned int len, const Type& v0); // m(n,val);
CoolM_Vector(unsigned int len, int n, Type v00, ...); // Opt. values
CoolM_Vector(const CoolM_Vector&); // v1(v2);
~CoolM_Vector(); // Destructor

inline void put (unsigned int i, const Type&); // Assign value
inline Type& get (unsigned int i); // Get value
void fill (const Type&); // set elements to value

inline Type& operator() (unsigned int i); // Access wo checks

CoolM_Vector& operator= (const Type&); // Assignment: m = 2;
CoolM_Vector& operator= (const CoolM_Vector&); // Assignment: m = n;
inline CoolM_Vector& operator= (CoolEnvelope< CoolM_Vector >&); // envelope to vector

Boolean operator== (const CoolM_Vector&) const; // CoolM_Vector equality test
inline Boolean operator!= (const CoolM_Vector&) const; // inequality test
void set_compare (Boolean (*) (const Type&, const Type&) = NULL); // Compare function

friend ostream& operator<< (ostream&, const CoolM_Vector&);
/*inline##*/ friend ostream& operator<< (ostream&, const CoolM_Vector*);

CoolM_Vector& operator+= (const Type&); // binary operation and assignment
CoolM_Vector& operator*= (const Type&); // Mutate vector data
CoolM_Vector& operator/= (const Type&);
inline CoolM_Vector& operator-= (const Type&);

CoolM_Vector& operator+= (const CoolM_Vector&);
CoolM_Vector& operator-= (const CoolM_Vector&);

CoolM_Vector& pre_multiply (const CoolMatrix&); // v = m * v
CoolM_Vector& post_multiply (const CoolMatrix&); // v = v * m
inline CoolM_Vector& operator*= (const CoolMatrix&); // v = v * m, post-multiply

CoolEnvelope< CoolM_Vector > operator- () const; // negation and
CoolEnvelope< CoolM_Vector > operator+ (const Type&) const; // all binary operations
CoolEnvelope< CoolM_Vector > operator* (const Type&) const; // return by values.
CoolEnvelope< CoolM_Vector > operator/ (const Type&) const;

inline CoolEnvelope< CoolM_Vector > operator- (const Type&) const;
/*inline##*/ friend CoolEnvelope< CoolM_Vector > operator+(const Type&, const CoolM_Vector&);
/*inline##*/ friend CoolEnvelope< CoolM_Vector > operator-(const Type&, const CoolM_Vector&);
/*inline##*/ friend CoolEnvelope< CoolM_Vector > operator*(const Type&, const CoolM_Vector&);

// Fewer unnecessary copying with CoolEnvelope
// friend CoolM_Vector operator+ (const CoolM_Vector&,
// const CoolM_Vector&);
// friend CoolM_Vector operator- (const CoolM_Vector&,
// const CoolM_Vector&);

friend CoolEnvelope< CoolM_Vector > operator* (const CoolM_Vector&, const CoolMatrix&);
friend CoolEnvelope< CoolM_Vector > operator* (const CoolMatrix&, const CoolM_Vector&);

CoolEnvelope< CoolM_Vector > abs() const; // r[i] = abs(v[i])
CoolEnvelope< CoolM_Vector > sign() const; // r[i] = sign(v[i])
CoolEnvelope< CoolM_Vector > extract (unsigned int len, unsigned int start=0) const; // subvector
CoolM_Vector& update (const CoolM_Vector&, unsigned int start=0);

friend CoolEnvelope< CoolM_Vector > element_product (const CoolM_Vector&, // v[i] = a[i]*b[i]
const CoolM_Vector&);
friend CoolEnvelope< CoolM_Vector > element_quotient (const CoolM_Vector&, // v[i] = a[i]/b[i]
const CoolM_Vector&);

inline Type squared_magnitude() const; // dot(v,v)
inline Type magnitude() const; // sqrt(dot(v,v))
inline CoolM_Vector& normalize(); // v /= sqrt(dot(v,v))

inline Type& x() const; // get coordinates along
inline Type& y() const; // 4 axes.
inline Type& z() const;
inline Type& t() const;

friend Type dot_product (const CoolM_Vector&, // dot-product of n-dim vectors
const CoolM_Vector&);
friend Type cross_2d (const CoolM_Vector&, // cross-product of 2d-vectors
const CoolM_Vector&);
friend CoolEnvelope< CoolM_Vector > cross_3d (const CoolM_Vector&, // cross-product
const CoolM_Vector&); // of 3d-vectors

protected:
Type* data; // Pointer to the CoolM_Vector
static Boolean (*compare_s) (const Type&, const Type&); // Pointer operator== function
friend Boolean CoolM_Vector_is_data_equal (const Type&, const Type&);
};

//## BC++ 3.1 bug
void hack(CoolM_Vector);
void hack(CoolM_Vector);
void hack(CoolM_Vector);
//## add your type above
#include //## BC++ 3.1 bug prevents from moving to top

// Use envelope to avoid deep copy on return by value, and mutate in place
template
inline CoolEnvelope< CoolM_Vector > operator+ (const CoolM_Vector&arg1,const CoolM_Vector&arg2)
{ return CoolEnvOp(add)(arg1, arg2); }
template
inline CoolEnvelope< CoolM_Vector > operator- (const CoolM_Vector&arg1,const CoolM_Vector&arg2)
{ return CoolEnvOp(minus)(arg1, arg2); }


// get -- Get the element at specified index and return value
// Input: *this, index
// Output: Element value

template
inline Type& CoolM_Vector::get (unsigned int index) {
#if ERROR_CHECKING
if (index >= this->num_elmts) // If invalid index specified
this->index_error ("get", #Type, index); // Raise exception
#endif
return this->data[index];
}

// put -- Put the element value at specified index
// Input: *this, index, value
// Output: Element value

template
inline void CoolM_Vector::put (unsigned int index, const Type& value) {
#if ERROR_CHECKING
if (index >= this->num_elmts) // If invalid index specified
this->index_error ("put", #Type, index); // Raise exception
#endif
this->data[index] = value; // Assign data value
}

// operator() -- Overload () to get the element at specified index and return value
// Input: *this, index
// Output: Element reference

template
inline Type& CoolM_Vector::operator() (unsigned int index) {
return this->data[index]; // fast access without checks.
}

// operator= -- Assignment from an envelope back to real vector
// Input: envelope reference
// Output: vector reference with contents in envelope being swapped over

template
inline CoolM_Vector& CoolM_Vector::operator= (CoolEnvelope< CoolM_Vector >& env){
env.shallow_swap((CoolEnvelope< CoolM_Vector >*)this, &env); // same physical layout
return *this;
}

// operator-= -- Destructive vector subtraction of a scalar.
// Input: *this, scalar value
// Output: New vector reference

template
inline CoolM_Vector& CoolM_Vector::operator-= (const Type& value) {
return *this += (- value);
}


// operator*= -- Destructive multiply vector with matrix, and assignment. v = v*m
// num_elmts of vector must match num_rows of matrix
// Input: *this, matrix reference
// Output: Updated *this vector reference

template
inline CoolM_Vector& CoolM_Vector::operator*= (const CoolMatrix& m) {
return this->post_multiply(m);
}


// operator<< -- Overload the output operator to print a CoolM_Vector
// Input: ostream reference, CoolM_Vector pointer
// Output: ostream reference

template
inline ostream& operator<< (ostream& os, const CoolM_Vector* m) {
return os << *m;
}

// operator!= -- Perform not equal comparison test
// Input: *this, vector reference
// Output: TRUE/FALSE

template
inline Boolean CoolM_Vector::operator!= (const CoolM_Vector& v) const {
return (!operator== (v));
}


template
inline CoolEnvelope< CoolM_Vector > operator+ (const Type& value,
const CoolM_Vector& v) {
return v + value;
}

// operator- -- Non-destructive vector substraction of a scalar.
// Input: *this, scalar value
// Output: New vector

template
inline CoolEnvelope< CoolM_Vector > CoolM_Vector::operator-(const Type& value) const {
return (*this) + (- value);
}

template
inline CoolEnvelope< CoolM_Vector > operator- (const Type& value,
const CoolM_Vector& v) {
return (- v) + value;
}


template
inline CoolEnvelope< CoolM_Vector > operator* (const Type& value,
const CoolM_Vector& v) {
return v * value;
}


// squared_magnitude -- Return dot-product(*this,*this)
// Input: *this
// Ouput: squared of magnitude or dot-product(v,v).

template
inline Type CoolM_Vector::squared_magnitude() const {
return dot_product(*this,*this);
}

// magnitude -- Return square-root of dot-product(*this,*this)
// Input: *this
// Ouput: magnitude of vector.

template
inline Type CoolM_Vector::magnitude() const {
return (Type) sqrt(double(dot_product(*this,*this)));
}

// normalize -- Mutate vector to have magnitude = 1.
// Input: *this
// Ouput: Mutated vector

template
inline CoolM_Vector& CoolM_Vector::normalize() {
Type mag = this->magnitude();
return (*this /= mag);
}


// x,y,z,t -- return the coordinates along the axes
// Input: *this
// Output: coordinate by reference

template
inline Type& CoolM_Vector::x() const{
return data[0];
}

template
inline Type& CoolM_Vector::y() const {
return data[1];
}

template
inline Type& CoolM_Vector::z() const {
return data[2];
}

template
inline Type& CoolM_Vector::t() const {
return data[3];
}

//## hack to workaround BC++ 3.1 Envelope bug
#undef CoolEnvelope

#endif // End of M_VECTORH