NOX::NOXPlaya::Vector Class Reference

List of all members.

Public Member Functions

 Vector (const NOX::NOXPlaya::Vector &source, NOX::CopyType type=DeepCopy)
 Copy constructor.
 Vector (const Playa::Vector< double > &source, NOX::CopyType type=DeepCopy)
 Copy constructor.
 Vector (const NOX::NOXPlaya::Vector &source, int numdigits, NOX::CopyType type=DeepCopy)
 Copy constructor when user requests specific precision.
 Vector (const Playa::Vector< double > &source, int numdigits, NOX::CopyType type=DeepCopy)
 Copy constructor when user requests specific precision.
Playa::Vector< double > & getPlayaVector ()
const Playa::Vector< double > & getPlayaVector () const
int getPrecision () const
int length () const
 The length of a Playa vector is known only by the vector space it belongs to We query the vector space and ask its dimension.
ostream & leftshift (std::ostream &stream) const
 Prints out the vector to the specified stream.
void print () const
NOX::Abstract::Vector & init (double value)
NOX::Abstract::Vector & operator= (const NOX::NOXPlaya::Vector &y)
NOX::Abstract::Vector & operator= (const NOX::Abstract::Vector &y)
NOX::Abstract::Vector & abs (const NOX::NOXPlaya::Vector &y)
NOX::Abstract::Vector & abs (const NOX::Abstract::Vector &y)
NOX::Abstract::Vector & reciprocal (const NOX::NOXPlaya::Vector &y)
NOX::Abstract::Vector & reciprocal (const NOX::Abstract::Vector &y)
NOX::Abstract::Vector & scale (double gamma)
NOX::Abstract::Vector & scale (const NOX::NOXPlaya::Vector &a)
NOX::Abstract::Vector & scale (const NOX::Abstract::Vector &a)
NOX::Abstract::Vector & update (double alpha, const NOX::NOXPlaya::Vector &a, double gamma=0.0)
NOX::Abstract::Vector & update (double alpha, const NOX::Abstract::Vector &a, double gamma=0.0)
NOX::Abstract::Vector & update (double alpha, const NOX::NOXPlaya::Vector &a, double beta, const NOX::NOXPlaya::Vector &b, double gamma=0.0)
NOX::Abstract::Vector & update (double alpha, const NOX::Abstract::Vector &a, double beta, const NOX::Abstract::Vector &b, double gamma=0.0)
RCP< NOX::Abstract::Vector > clone (NOX::CopyType type=NOX::DeepCopy) const
double norm (NOX::Abstract::Vector::NormType type=NOX::Abstract::Vector::TwoNorm) const
double norm (const NOX::NOXPlaya::Vector &weights) const
double norm (const NOX::Abstract::Vector &weights) const
double dot (const NOX::NOXPlaya::Vector &y) const
double dot (const NOX::Abstract::Vector &y) const
double innerProduct (const NOX::Abstract::Vector &y) const

Private Attributes

int precision
Playa::Vector< double > x


Detailed Description

Implementation of the NOX::Abstract::Vector interface for Playa::Vector<double> (using Playa handle to PlayaCore).

Author:
Jill Reese and Kevin Long

Definition at line 31 of file NOX_Playa_Vector.hpp.


Constructor & Destructor Documentation

NOX::NOXPlaya::Vector::Vector ( const NOX::NOXPlaya::Vector source,
NOX::CopyType  type = DeepCopy 
)

Copy constructor.

Definition at line 20 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::copy(), and x.

NOX::NOXPlaya::Vector::Vector ( const Playa::Vector< double > &  source,
NOX::CopyType  type = DeepCopy 
)

Copy constructor.

Definition at line 41 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::copy(), and x.

NOX::NOXPlaya::Vector::Vector ( const NOX::NOXPlaya::Vector source,
int  numdigits,
NOX::CopyType  type = DeepCopy 
)

Copy constructor when user requests specific precision.

Definition at line 64 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::copy(), and x.

NOX::NOXPlaya::Vector::Vector ( const Playa::Vector< double > &  source,
int  numdigits,
NOX::CopyType  type = DeepCopy 
)

Copy constructor when user requests specific precision.

Definition at line 87 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::copy(), and x.


Member Function Documentation

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::abs ( const NOX::Abstract::Vector &  y  ) 

Element-wise absolute value

Definition at line 150 of file NOX_Playa_Vector.cpp.

References abs().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::abs ( const NOX::NOXPlaya::Vector y  ) 

Element-wise absolute value

Definition at line 156 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::acceptCopyOf(), Playa::Vector< Scalar >::selfAbs(), and x.

Referenced by abs().

RCP< NOX::Abstract::Vector > NOX::NOXPlaya::Vector::clone ( NOX::CopyType  type = NOX::DeepCopy  )  const

Definition at line 241 of file NOX_Playa_Vector.cpp.

double NOX::NOXPlaya::Vector::dot ( const NOX::Abstract::Vector &  y  )  const

Definition at line 287 of file NOX_Playa_Vector.cpp.

References dot().

double NOX::NOXPlaya::Vector::dot ( const NOX::NOXPlaya::Vector y  )  const

Definition at line 297 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::dot(), length(), and x.

Referenced by dot(), and innerProduct().

const Playa::Vector< double > & NOX::NOXPlaya::Vector::getPlayaVector (  )  const

Access to a read-only reference to the underlying Playa vector

Definition at line 117 of file NOX_Playa_Vector.cpp.

References x.

Playa::Vector< double > & NOX::NOXPlaya::Vector::getPlayaVector (  ) 

int NOX::NOXPlaya::Vector::getPrecision (  )  const

Access to the vector precision expected by user

Definition at line 122 of file NOX_Playa_Vector.cpp.

References precision.

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::init ( double  value  ) 

Initialize all elements to a constant

Definition at line 143 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::setToConstant(), and x.

double NOX::NOXPlaya::Vector::innerProduct ( const NOX::Abstract::Vector &  y  )  const

Definition at line 292 of file NOX_Playa_Vector.cpp.

References dot().

ostream & NOX::NOXPlaya::Vector::leftshift ( std::ostream &  stream  )  const

Prints out the vector to the specified stream.

For example, a vector would appear as

\[ \left[ \; 0.1 \; 2.34 \; 5 \; \right] \]

It will be all on one line, with a single space between each entry, bracketed on either side.

Definition at line 315 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::print(), and x.

Referenced by std::operator<<().

int NOX::NOXPlaya::Vector::length (  )  const

The length of a Playa vector is known only by the vector space it belongs to We query the vector space and ask its dimension.

Definition at line 308 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::space(), and x.

Referenced by dot(), and norm().

double NOX::NOXPlaya::Vector::norm ( const NOX::Abstract::Vector &  weights  )  const

Definition at line 272 of file NOX_Playa_Vector.cpp.

References norm().

double NOX::NOXPlaya::Vector::norm ( const NOX::NOXPlaya::Vector weights  )  const

Definition at line 277 of file NOX_Playa_Vector.cpp.

References getPlayaVector(), length(), Playa::Vector< Scalar >::norm2(), and x.

double NOX::NOXPlaya::Vector::norm ( NOX::Abstract::Vector::NormType  type = NOX::Abstract::Vector::TwoNorm  )  const

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::operator= ( const NOX::Abstract::Vector &  y  ) 

Assignment operator

Definition at line 127 of file NOX_Playa_Vector.cpp.

References operator=().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::operator= ( const NOX::NOXPlaya::Vector y  ) 

Assignment operator

Definition at line 133 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::copy(), getPlayaVector(), and x.

Referenced by operator=().

void NOX::NOXPlaya::Vector::print (  )  const

Definition at line 329 of file NOX_Playa_Vector.cpp.

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::reciprocal ( const NOX::Abstract::Vector &  y  ) 

Element-wise reciprocal

Definition at line 164 of file NOX_Playa_Vector.cpp.

References reciprocal().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::reciprocal ( const NOX::NOXPlaya::Vector y  ) 

Element-wise reciprocal

Definition at line 170 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::acceptCopyOf(), Playa::Vector< Scalar >::selfReciprocal(), and x.

Referenced by reciprocal().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::scale ( const NOX::Abstract::Vector &  a  ) 

Definition at line 223 of file NOX_Playa_Vector.cpp.

References scale().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::scale ( const NOX::NOXPlaya::Vector a  ) 

Definition at line 229 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::selfDotStar(), and x.

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::scale ( double  gamma  ) 

Definition at line 178 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::scale(), and x.

Referenced by scale().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::update ( double  alpha,
const NOX::Abstract::Vector &  a,
double  beta,
const NOX::Abstract::Vector &  b,
double  gamma = 0.0 
)

Definition at line 201 of file NOX_Playa_Vector.cpp.

References update().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::update ( double  alpha,
const NOX::NOXPlaya::Vector a,
double  beta,
const NOX::NOXPlaya::Vector b,
double  gamma = 0.0 
)

Definition at line 212 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::update(), and x.

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::update ( double  alpha,
const NOX::Abstract::Vector &  a,
double  gamma = 0.0 
)

Definition at line 184 of file NOX_Playa_Vector.cpp.

References update().

NOX::Abstract::Vector & NOX::NOXPlaya::Vector::update ( double  alpha,
const NOX::NOXPlaya::Vector a,
double  gamma = 0.0 
)

Definition at line 192 of file NOX_Playa_Vector.cpp.

References Playa::Vector< Scalar >::update(), and x.

Referenced by update().


Member Data Documentation

user-specified precision for printing vectors

Definition at line 175 of file NOX_Playa_Vector.hpp.

Referenced by getPrecision().

The Playa vector owned by this object.

Definition at line 178 of file NOX_Playa_Vector.hpp.

Referenced by abs(), dot(), getPlayaVector(), init(), leftshift(), length(), norm(), operator=(), reciprocal(), scale(), update(), and Vector().

Site Contact