RWROCJRef< TypeT > Class Template Reference

Handles a reference to a datum that may be read-only, or may need to be conjugated. More...

#include <rw/lapack/mat.h>

Public Member Functions
	RWROCJRef (TypeT &x, bool ro=false, bool cj=false)
	operator TypeT ()
RWROCJRef< TypeT > &	operator= (TypeT x)

Detailed Description

template<class TypeT>
class RWROCJRef< TypeT >

RWROCJRef handles a reference to a datum that may be read-only, or may need to be conjugated. It is used by the RWHermBandMat classes. Elements outside the band are defined as 0. Accessing these elements returns an RWROCJRef initialized with a static variable initialized to 0, and information that the reference is read-only.

Constructor & Destructor Documentation

template<class TypeT >

RWROCJRef< TypeT >::RWROCJRef ( TypeT &  x, bool  ro = false, bool  cj = false  )

inline

Builds a reference to x. The parameter ro indicates if the reference should be considered read-only. The parameter cj indicates if the reference should be conjugated.

Member Function Documentation

template<class TypeT >

RWROCJRef< TypeT >::operator TypeT ( )

inline

This type conversion operator is invoked by the compiler as necessary to return the value referenced by the class for use as a right-side value. It may have to modify the value as necessary (for example, to take its conjugate).

template<class TypeT >

RWROCJRef<TypeT>& RWROCJRef< TypeT >::operator= ( TypeT  x )

inline

This function changes the value referenced by the class to the value x, after modifying x if necessary (for example, by taking its conjugate). If the reference is supposed to be read-only, a runtime error occurs.