Playa::VectorSpace< Scalar > Class Template Reference
User-level VectorSpace class. More...
Public Member Functions | |
| VectorSpace () | |
| Empty ctor. | |
| VectorSpace (Handleable< const VectorSpaceBase< Scalar > > *rawPtr) | |
| Construct a VectorSpace<Scalar> with a raw pointer to a const VectorSpaceBase<Scalar>. | |
| VectorSpace (const RefCountPtr< const VectorSpaceBase< Scalar > > &smartPtr) | |
| Construct a VectorSpace<Scalar> with a smart pointer to a const VectorSpaceBase<Scalar>. | |
| Vector< Scalar > | createMember () const |
| Create a new element of this vector space. | |
| int | dim () const |
| Return the dimension of the space. | |
| int | baseGlobalNaturalIndex () const |
| Return the lowest global index accessible on this processor. | |
| int | numLocalElements () const |
| Return the number of elements owned by this processor. | |
| const MPIComm & | comm () const |
| Return the MPI communicator. | |
| bool | isCompatible (const VectorSpace< Scalar > &vecSpc) const |
| Check compatibility with another space. | |
| bool | operator== (const VectorSpace< Scalar > &other) const |
| test equality between two spaces | |
| bool | operator!= (const VectorSpace< Scalar > &other) const |
| test inequality of two spaces | |
| bool | contains (const Vector< Scalar > &vec) const |
| test whether the space contains a given vector | |
| int | numBlocks () const |
| return the number of subblocks at the highest level. | |
| bool | isBlockSpace () const |
| indicate whether I am a block vector space | |
| const VectorSpace< Scalar > & | getBlock (int i) const |
| get the i-th subblock | |
| const VectorSpace< Scalar > & | getBlock (const BlockIterator< Scalar > &iter) const |
| get a subblock as specified by a block iterator | |
| const VectorSpace< Scalar > & | getBlock (const std::deque< int > &iter) const |
| get a subblock as specified by a deque of indices | |
| BlockIterator< Scalar > | beginBlock () const |
| BlockIterator< Scalar > | endBlock () const |
| int | mapToGNI (const BlockIterator< Scalar > &b, int indexWithinBlock) const |
| bool | containsGNI (int gni) const |
| void | getBlockAndOffsetFromGNI (int gni, BlockIterator< Scalar > &block, int &indexWithinBlock) const |
Related Functions | |
| (Note that these are not member functions.) | |
| template<class Scalar > | |
| VectorSpace< Scalar > | blockSpace (const VectorSpace< Scalar > &v1) |
| template<class Scalar > | |
| VectorSpace< Scalar > | blockSpace (const VectorSpace< Scalar > &v1, const VectorSpace< Scalar > &v2) |
| template<class Scalar > | |
| VectorSpace< Scalar > | blockSpace (const VectorSpace< Scalar > &v1, const VectorSpace< Scalar > &v2, const VectorSpace< Scalar > &v3) |
| template<class Scalar > | |
| VectorSpace< Scalar > | blockSpace (const VectorSpace< Scalar > &v1, const VectorSpace< Scalar > &v2, const VectorSpace< Scalar > &v3, const VectorSpace< Scalar > &v4) |
| template<class Scalar > | |
| VectorSpace< Scalar > | blockSpace (const Array< VectorSpace< Scalar > > &x) |
Detailed Description
template<class Scalar>
class Playa::VectorSpace< Scalar >
User-level VectorSpace class.
Definition at line 21 of file PlayaVectorSpaceDecl.hpp.
Constructor & Destructor Documentation
| Playa::VectorSpace< Scalar >::VectorSpace | ( | ) | [inline] |
Empty ctor.
| Playa::VectorSpace< Scalar >::VectorSpace | ( | Handleable< const VectorSpaceBase< Scalar > > * | rawPtr | ) | [inline] |
Construct a VectorSpace<Scalar> with a raw pointer to a const VectorSpaceBase<Scalar>.
| Playa::VectorSpace< Scalar >::VectorSpace | ( | const RefCountPtr< const VectorSpaceBase< Scalar > > & | smartPtr | ) | [inline] |
Construct a VectorSpace<Scalar> with a smart pointer to a const VectorSpaceBase<Scalar>.
Member Function Documentation
| int Playa::VectorSpace< Scalar >::baseGlobalNaturalIndex | ( | ) | const [inline] |
Return the lowest global index accessible on this processor.
Definition at line 63 of file PlayaVectorSpaceImpl.hpp.
References Playa::Handle< const VectorSpaceBase< Scalar > >::ptr().
Referenced by Playa::PoissonBoltzmannOp::computeJacobianAndFunction(), Playa::VectorSpace< Scalar >::containsGNI(), Playa::PoissonBoltzmannOp::exactSoln(), Playa::ObjectiveBase::fdCheck(), Sundance::FunctionalEvaluator::fdGradientCheck(), Playa::VectorSpace< Scalar >::getBlockAndOffsetFromGNI(), Playa::makeEpetraDiagonalMatrix(), Playa::VectorSpace< Scalar >::mapToGNI(), and Playa::PoissonBoltzmannOp::PoissonBoltzmannOp().
| BlockIterator< Scalar > Playa::VectorSpace< Scalar >::beginBlock | ( | ) | const [inline] |
Definition at line 169 of file PlayaVectorSpaceImpl.hpp.
Referenced by Playa::VectorSpace< Scalar >::getBlockAndOffsetFromGNI(), and Playa::VectorSpace< Scalar >::mapToGNI().
| const MPIComm& Playa::VectorSpace< Scalar >::comm | ( | ) | const [inline] |
| bool Playa::VectorSpace< Scalar >::contains | ( | const Vector< Scalar > & | vec | ) | const [inline] |
test whether the space contains a given vector
Definition at line 93 of file PlayaVectorSpaceImpl.hpp.
References Playa::Vector< Scalar >::space().
| bool Playa::VectorSpace< Scalar >::containsGNI | ( | int | gni | ) | const [inline] |
Definition at line 198 of file PlayaVectorSpaceImpl.hpp.
References Playa::VectorSpace< Scalar >::baseGlobalNaturalIndex(), and Playa::VectorSpace< Scalar >::numLocalElements().
| Vector< Scalar > Playa::VectorSpace< Scalar >::createMember | ( | ) | const [inline] |
Create a new element of this vector space.
Definition at line 52 of file PlayaVectorSpaceImpl.hpp.
References Playa::Handle< const VectorSpaceBase< Scalar > >::ptr(), and Playa::Vector< Scalar >::setToConstant().
Referenced by Sundance::NLOp::computeFunctionValue(), Playa::PoissonBoltzmannOp::computeJacobianAndFunction(), Sundance::DiscreteSpace::createVector(), Playa::denseSVD(), Playa::PoissonBoltzmannOp::exactSoln(), Playa::getEpetraDiagonal(), Playa::PoissonBoltzmannOp::getInitialGuess(), Sundance::LinearEigenproblem::lumpedOperator(), Playa::InitTraits< SimpleMV, LinearOperator< double > >::makeMV(), Playa::LinearCombinationTester< Scalar >::nonModifyingOpTests(), Playa::LineSearchBasedOptBase::run(), Playa::LinearCombinationTester< Scalar >::selfModifyingOpTests(), and Playa::AnasaziEigensolver< Scalar >::solve().
| int Playa::VectorSpace< Scalar >::dim | ( | ) | const [inline] |
Return the dimension of the space.
Definition at line 30 of file PlayaVectorSpaceDecl.hpp.
Referenced by Playa::PoissonBoltzmannOp::computeJacobianAndFunction(), Playa::ObjectiveBase::fdCheck(), Sundance::FunctionalEvaluator::fdGradientCheck(), Playa::HeatOperator1D::HeatOperator1D(), Playa::MassMatrix1D::init(), and Playa::MatrixLaplacian1D::init().
| BlockIterator< Scalar > Playa::VectorSpace< Scalar >::endBlock | ( | ) | const [inline] |
Definition at line 175 of file PlayaVectorSpaceImpl.hpp.
Referenced by Playa::VectorSpace< Scalar >::getBlockAndOffsetFromGNI().
| const VectorSpace< Scalar > & Playa::VectorSpace< Scalar >::getBlock | ( | const std::deque< int > & | iter | ) | const [inline] |
get a subblock as specified by a deque of indices
Definition at line 148 of file PlayaVectorSpaceImpl.hpp.
| const VectorSpace< Scalar > & Playa::VectorSpace< Scalar >::getBlock | ( | const BlockIterator< Scalar > & | iter | ) | const [inline] |
get a subblock as specified by a block iterator
Definition at line 135 of file PlayaVectorSpaceImpl.hpp.
References Playa::BlockIterator< Scalar >::atEnd(), and Playa::BlockIterator< Scalar >::blockIndex().
| const VectorSpace< Scalar > & Playa::VectorSpace< Scalar >::getBlock | ( | int | i | ) | const [inline] |
get the i-th subblock
Definition at line 118 of file PlayaVectorSpaceImpl.hpp.
References Playa::BlockVectorSpaceBase< Scalar >::getBlock(), Playa::VectorSpace< Scalar >::numBlocks(), and Playa::Handle< const VectorSpaceBase< Scalar > >::ptr().
Referenced by Playa::DefaultBlockVector< Scalar >::DefaultBlockVector(), Playa::VectorSpace< Scalar >::getBlockAndOffsetFromGNI(), Playa::BlockIterator< Scalar >::goToStart(), Playa::VectorSpace< Scalar >::mapToGNI(), and Playa::SimpleBlockOp< Scalar >::SimpleBlockOp().
| void Playa::VectorSpace< Scalar >::getBlockAndOffsetFromGNI | ( | int | gni, | |
| BlockIterator< Scalar > & | block, | |||
| int & | indexWithinBlock | |||
| ) | const [inline] |
| bool Playa::VectorSpace< Scalar >::isBlockSpace | ( | ) | const [inline] |
indicate whether I am a block vector space
Definition at line 109 of file PlayaVectorSpaceImpl.hpp.
References Playa::Handle< const VectorSpaceBase< Scalar > >::ptr().
Referenced by Playa::BlockIterator< Scalar >::goToStart().
| bool Playa::VectorSpace< Scalar >::isCompatible | ( | const VectorSpace< Scalar > & | vecSpc | ) | const [inline] |
Check compatibility with another space.
Definition at line 80 of file PlayaVectorSpaceImpl.hpp.
References Playa::Handle< const VectorSpaceBase< Scalar > >::ptr().
Referenced by Playa::VectorSpace< Scalar >::operator==().
| int Playa::VectorSpace< Scalar >::mapToGNI | ( | const BlockIterator< Scalar > & | b, | |
| int | indexWithinBlock | |||
| ) | const [inline] |
Definition at line 182 of file PlayaVectorSpaceImpl.hpp.
References Playa::VectorSpace< Scalar >::baseGlobalNaturalIndex(), Playa::VectorSpace< Scalar >::beginBlock(), Playa::VectorSpace< Scalar >::getBlock(), and Playa::VectorSpace< Scalar >::numBlocks().
| int Playa::VectorSpace< Scalar >::numBlocks | ( | ) | const [inline] |
return the number of subblocks at the highest level.
Definition at line 101 of file PlayaVectorSpaceImpl.hpp.
References Playa::Handle< const VectorSpaceBase< Scalar > >::ptr().
Referenced by Playa::DefaultBlockVector< Scalar >::DefaultBlockVector(), Playa::VectorSpace< Scalar >::getBlock(), Playa::VectorSpace< Scalar >::getBlockAndOffsetFromGNI(), Playa::VectorSpace< Scalar >::mapToGNI(), and Playa::SimpleBlockOp< Scalar >::SimpleBlockOp().
| int Playa::VectorSpace< Scalar >::numLocalElements | ( | ) | const [inline] |
Return the number of elements owned by this processor.
Definition at line 70 of file PlayaVectorSpaceImpl.hpp.
References Playa::Handle< const VectorSpaceBase< Scalar > >::ptr().
Referenced by Playa::PoissonBoltzmannOp::computeJacobianAndFunction(), Playa::VectorSpace< Scalar >::containsGNI(), Playa::PoissonBoltzmannOp::exactSoln(), Playa::ObjectiveBase::fdCheck(), Sundance::FunctionalEvaluator::fdGradientCheck(), Playa::makeEpetraDiagonalMatrix(), and Playa::PoissonBoltzmannOp::PoissonBoltzmannOp().
| bool Playa::VectorSpace< Scalar >::operator!= | ( | const VectorSpace< Scalar > & | other | ) | const [inline] |
test inequality of two spaces
Definition at line 43 of file PlayaVectorSpaceImpl.hpp.
References Playa::VectorSpace< Scalar >::operator==().
| bool Playa::VectorSpace< Scalar >::operator== | ( | const VectorSpace< Scalar > & | other | ) | const [inline] |
test equality between two spaces
Definition at line 35 of file PlayaVectorSpaceImpl.hpp.
References Playa::VectorSpace< Scalar >::isCompatible().
Referenced by Playa::VectorSpace< Scalar >::operator!=().
Friends And Related Function Documentation
| VectorSpace< Scalar > blockSpace | ( | const Array< VectorSpace< Scalar > > & | x | ) | [related] |
Definition at line 117 of file PlayaDefaultBlockVectorSpaceImpl.hpp.
| VectorSpace< Scalar > blockSpace | ( | const VectorSpace< Scalar > & | v1, | |
| const VectorSpace< Scalar > & | v2, | |||
| const VectorSpace< Scalar > & | v3, | |||
| const VectorSpace< Scalar > & | v4 | |||
| ) | [related] |
Definition at line 101 of file PlayaDefaultBlockVectorSpaceImpl.hpp.
| VectorSpace< Scalar > blockSpace | ( | const VectorSpace< Scalar > & | v1, | |
| const VectorSpace< Scalar > & | v2, | |||
| const VectorSpace< Scalar > & | v3 | |||
| ) | [related] |
Definition at line 87 of file PlayaDefaultBlockVectorSpaceImpl.hpp.
| VectorSpace< Scalar > blockSpace | ( | const VectorSpace< Scalar > & | v1, | |
| const VectorSpace< Scalar > & | v2 | |||
| ) | [related] |
Definition at line 75 of file PlayaDefaultBlockVectorSpaceImpl.hpp.
| VectorSpace< Scalar > blockSpace | ( | const VectorSpace< Scalar > & | v1 | ) | [related] |
Definition at line 64 of file PlayaDefaultBlockVectorSpaceImpl.hpp.