linbox
Public Member Functions
RandomSparseStream< Field, _Vector, RandIter, Trait > Class Template Reference

Random sparse vector stream. More...

#include <stream.h>

+ Inheritance diagram for RandomSparseStream< Field, _Vector, RandIter, Trait >:

Public Member Functions

 RandomSparseStream (const Field &F, double p, size_t n, size_t m=0)
 Constructor Construct a new stream with the given field and vector size. More...
 
 RandomSparseStream (const Field &F, const RandIter &r, double p, size_t n, size_t m=0, int seed=(int) time(NULL))
 Constructor. More...
 
Vector & get (Vector &v)
 Get next element. More...
 
Self_toperator>> (Vector &v)
 Extraction operator form.
 
size_t size () const
 Number of vectors to be created.
 
size_t pos () const
 Number of vectors created so far.
 
size_t dim () const
 Dimension of the space.
 
 operator bool () const
 Check whether we have reached the end.
 
void reset ()
 Reset the stream to start at the beginning.
 
void setP (double p)
 Set the probability of a nonzero entry.
 
void rewind ()
 Alias for reset.
 
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
 

Detailed Description

template<class Field, class _Vector = Sparse_Vector<typename Field::Element>, class RandIter = typename Field::RandIter, class Trait = typename VectorTraits<_Vector>::VectorCategory>
class LinBox::RandomSparseStream< Field, _Vector, RandIter, Trait >

Random sparse vector stream.

Generates a sequence of random sparse vectors over a given field

Examples:
examples/dot-product.C.

Constructor & Destructor Documentation

RandomSparseStream ( const Field &  F,
double  p,
size_t  n,
size_t  m = 0 
)

Constructor Construct a new stream with the given field and vector size.

Parameters
FField over which to create random vectors
pProportion of nonzero entries
nSize of vectors
mNumber of vectors to return (0 for unlimited)
RandomSparseStream ( const Field &  F,
const RandIter &  r,
double  p,
size_t  n,
size_t  m = 0,
int  seed = (int) time(NULL) 
)

Constructor.

Construct a new stream with the given field and vector size.

Parameters
FField over which to create random vectors
r
nSize of vectors
pProportion of nonzero entries
mNumber of vectors to return (0 for unlimited)
seed

Member Function Documentation

Vector& get ( Vector &  v)
virtual

Get next element.

Parameters
vVector into which to generate random vector
Returns
reference to new random vector

Implements VectorStream< _Vector >.


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