VectorStream Class Template Reference
[linbox/vector]

#include <stream.h>

Inheritance diagram for VectorStream:

---

Detailed Description

template<class _Vector>
class LinBox::VectorStream< _Vector >

Vector factory.

This is an abstract base class that generates a sequence of vectors in a generic way. Typical uses would be in tests, where the same test might be run on a sequence of random vectors or on e_1, ..., e_n.

Public Types
typedef _Vector	Vector
typedef VectorStream< Vector >	Self_t
Public Member Functions
virtual	~VectorStream ()
virtual Vector &	get (Vector &v)=0
Self_t &	operator>> (Vector &v)
virtual size_t	size () const =0
virtual size_t	pos () const =0
virtual size_t	dim () const =0
virtual	operator bool () const =0
virtual void	reset ()=0
void	rewind ()
Legacy interface
These functions provide compatiblity with older parts of the library. Their use is deprecated.
Vector &	next (Vector &v)
size_t	j () const
size_t	m () const
size_t	n () const

---

Member Typedef Documentation

typedef _Vector Vector

Reimplemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

typedef VectorStream<Vector> Self_t

Reimplemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

---

Constructor & Destructor Documentation

virtual ~VectorStream (   )  [inline, virtual]

---

Member Function Documentation

virtual Vector& get (  Vector &  v  )  [pure virtual]

Get the next vector from the factory and store it in v Implemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

Self_t& operator>> (  Vector &  v  )  [inline]

Extraction operator form Reimplemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

virtual size_t size (   )  const [pure virtual]

Get the number of vectors to be constructed in this stream Implemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

virtual size_t pos (   )  const [pure virtual]

Get the number of vectors constructed so far Implemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

virtual size_t dim (   )  const [pure virtual]

Get the dimension of each vector Implemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

virtual operator bool (   )  const [pure virtual]

Return true if and only if the vector stream still has more vectors to construct Implemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

virtual void reset (   )  [pure virtual]

Reset the vector stream to the beginning. Implemented in ConstantVectorStream, RandomDenseStream, RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >, RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >, StandardBasisStream, StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >, StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >, and StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >.

void rewind (   )  [inline]

Alias for reset

Vector& next (  Vector &  v  )  [inline]

size_t j (   )  const [inline]

size_t m (   )  const [inline]

size_t n (   )  const [inline]

---