Zenautics::Matrix::RealOnlyAccess Class Reference

#include <Matrix.h>


Detailed Description

A nested class for access only to the real part of the matrix. It is used for operator[] access by the Matrix.

Sequential [][] operators can be used to access the matrix. The first overload of [] is at the Matrix level. This returns a copy of a RealOnlyAccess and the second overload of [] allows access to the required element from the matrix.

For matrices that are always real. This method of accessing each element is the most efficient.

Definition at line 3321 of file Matrix.h.


Public Member Functions

double & operator[] (const unsigned col)
 Set or get an element value.
 RealOnlyAccess (MTX &pMatrix, const unsigned row)
 The only constructor.
virtual ~RealOnlyAccess ()
 The destructor.
RealOnlyAccessoperator= (const double value)
 The assignment operator from a double for single index operations.
RealOnlyAccessoperator= (RealOnlyAccess &rhs)
 The assignment operator from another RealOnlyAccess object for single index operations.
RealOnlyAccessoperator= (Element &rhs)
 The assignment operator from a MatrixElement object for single index operations.
 operator const double ()
 The casting operator overload for double.
bool operator+= (const int scalar)
 add a scaler int (shorthand notation: A[0] += 5).
bool operator+= (const float scalar)
 add a scaler float (shorthand notation: A[0] += 5).
bool operator+= (const double scalar)
 add a scaler double (shorthand notation: A[0] += 5).
bool operator-= (const int scalar)
 subtract a scaler int (shorthand notation: A[0] -= 5).
bool operator-= (const float scalar)
 subtract a scaler float (shorthand notation: A[0] -= 5).
bool operator-= (const double scalar)
 subtract a scaler double (shorthand notation: A[0] -= 5).
bool operator *= (const int scalar)
 multiply a scalar int (shorthand notation: A[0] *= 5).
bool operator *= (const float scalar)
 multiply a scalar float (shorthand notation: A[0] *= 5).
bool operator *= (const double scalar)
 multiply a scalar double (shorthand notation: A[0] *= 5).
bool operator/= (const int scalar)
 divide a scalar int (shorthand notation: A[0] /= 5).
bool operator/= (const float scalar)
 divide a scalar float (shorthand notation: A[0] /= 5).
bool operator/= (const double scalar)
 divide a scalar double (shorthand notation: A[0] /= 5).

Friends

class Matrix
 The matrix is a friend class.

Constructor & Destructor Documentation

Zenautics::Matrix::RealOnlyAccess::RealOnlyAccess ( MTX pMatrix,
const unsigned  row 
)

The only constructor.

Definition at line 3362 of file Matrix.cpp.

Zenautics::Matrix::RealOnlyAccess::~RealOnlyAccess (  )  [virtual]

The destructor.

Definition at line 3366 of file Matrix.cpp.


Member Function Documentation

double & Zenautics::Matrix::RealOnlyAccess::operator[] ( const unsigned  col  ) 

Set or get an element value.

Definition at line 3407 of file Matrix.cpp.

Matrix::RealOnlyAccess & Zenautics::Matrix::RealOnlyAccess::operator= ( const double  value  ) 

The assignment operator from a double for single index operations.

Definition at line 3432 of file Matrix.cpp.

Matrix::RealOnlyAccess & Zenautics::Matrix::RealOnlyAccess::operator= ( RealOnlyAccess rhs  ) 

The assignment operator from another RealOnlyAccess object for single index operations.

Definition at line 3482 of file Matrix.cpp.

Matrix::RealOnlyAccess & Zenautics::Matrix::RealOnlyAccess::operator= ( Matrix::Element rhs  ) 

The assignment operator from a MatrixElement object for single index operations.

Definition at line 3495 of file Matrix.cpp.

Zenautics::Matrix::RealOnlyAccess::operator const double (  ) 

The casting operator overload for double.

Definition at line 3504 of file Matrix.cpp.

bool Zenautics::Matrix::RealOnlyAccess::operator+= ( const int  scalar  )  [inline]

add a scaler int (shorthand notation: A[0] += 5).

Definition at line 3351 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator+= ( const float  scalar  )  [inline]

add a scaler float (shorthand notation: A[0] += 5).

Definition at line 3352 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator+= ( const double  scalar  ) 

add a scaler double (shorthand notation: A[0] += 5).

Definition at line 3551 of file Matrix.cpp.

bool Zenautics::Matrix::RealOnlyAccess::operator-= ( const int  scalar  )  [inline]

subtract a scaler int (shorthand notation: A[0] -= 5).

Definition at line 3355 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator-= ( const float  scalar  )  [inline]

subtract a scaler float (shorthand notation: A[0] -= 5).

Definition at line 3356 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator-= ( const double  scalar  ) 

subtract a scaler double (shorthand notation: A[0] -= 5).

Definition at line 3604 of file Matrix.cpp.

bool Zenautics::Matrix::RealOnlyAccess::operator *= ( const int  scalar  )  [inline]

multiply a scalar int (shorthand notation: A[0] *= 5).

Definition at line 3359 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator *= ( const float  scalar  )  [inline]

multiply a scalar float (shorthand notation: A[0] *= 5).

Definition at line 3360 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator *= ( const double  scalar  ) 

multiply a scalar double (shorthand notation: A[0] *= 5).

Definition at line 3657 of file Matrix.cpp.

bool Zenautics::Matrix::RealOnlyAccess::operator/= ( const int  scalar  )  [inline]

divide a scalar int (shorthand notation: A[0] /= 5).

Definition at line 3363 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator/= ( const float  scalar  )  [inline]

divide a scalar float (shorthand notation: A[0] /= 5).

Definition at line 3364 of file Matrix.h.

bool Zenautics::Matrix::RealOnlyAccess::operator/= ( const double  scalar  ) 

divide a scalar double (shorthand notation: A[0] /= 5).

Definition at line 3710 of file Matrix.cpp.


Friends And Related Function Documentation

friend class Matrix [friend]

The matrix is a friend class.

Definition at line 3329 of file Matrix.h.


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