Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

SPUC::gf Class Reference
[Forward Error Correcting Codes]

Galois Field. More...

#include <gf.h>

Collaboration diagram for SPUC::gf:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 gf ()
 Constructor.
 gf (int qvalue)
 Constructor.
 gf (int qvalue, int inexp)
 Constructor.
 gf (const gf &ingf)
 Copy constructor.
void set (int qvalue, int inexp)
 gf(q) equals alpha ^ inexp
void set (int qvalue, const bvec &vectorspace)
 gf(q) equals the element that corresponds to the given vector space. The format is (...,c,b,a), where the element x is given as x=...+c*alpha^2+b*alpha+a.
void set_size (int qvalue)
 set q=2^mvalue
int get_size () const
 Return q.
bvec get_vectorspace () const
 Returns the vector space representation of gf(q).
int get_value () const
 Returns the alpha exponent.
int operator== (const gf &ingf) const
 Equality check.
int operator!= (const gf &ingf) const
 Not-equality check.
void operator= (const gf &ingf)
 gf(q) equals ingf
void operator= (const int inexp)
 gf(q) equals alpha^inexp
void operator+= (const gf &ingf)
 sum of two gf(q)
gf operator+ (const gf &ingf) const
 sum of two gf(q)
void operator-= (const gf &ingf)
 Difference of two gf(q), same as sum for q=2^m.
gf operator- (const gf &ingf) const
 Difference of two gf(q), same as sum for q=2^m.
void operator *= (const gf &ingf)
 product of two gf(q)
gf operator * (const gf &ingf) const
 product of two gf(q)
void operator/= (const gf &ingf)
 division of two gf(q)
gf operator/ (const gf &ingf) const
 product of two gf(q)

Friends

ostream & operator<< (ostream &os, const gf &ingf)
 Output stream for gf(q).

Detailed Description

Galois Field.


Constructor & Destructor Documentation

SPUC::gf::gf  )  [inline]
 

Constructor.

SPUC::gf::gf int  qvalue  )  [inline]
 

Constructor.

Here is the call graph for this function:

SPUC::gf::gf int  qvalue,
int  inexp
[inline]
 

Constructor.

Here is the call graph for this function:

SPUC::gf::gf const gf ingf  )  [inline]
 

Copy constructor.


Member Function Documentation

int SPUC::gf::get_size  )  const [inline]
 

Return q.

int gf::get_value  )  const
 

Returns the alpha exponent.

bvec gf::get_vectorspace  )  const
 

Returns the vector space representation of gf(q).

The format is (...,c,b,a), where the element x is given as x=...+c*alpha^2+b*alpha+a.

gf gf::operator * const gf ingf  )  const
 

product of two gf(q)

void gf::operator *= const gf ingf  ) 
 

product of two gf(q)

int gf::operator!= const gf ingf  )  const
 

Not-equality check.

gf gf::operator+ const gf ingf  )  const
 

sum of two gf(q)

void gf::operator+= const gf ingf  ) 
 

sum of two gf(q)

gf gf::operator- const gf ingf  )  const
 

Difference of two gf(q), same as sum for q=2^m.

void gf::operator-= const gf ingf  ) 
 

Difference of two gf(q), same as sum for q=2^m.

gf gf::operator/ const gf ingf  )  const
 

product of two gf(q)

void gf::operator/= const gf ingf  ) 
 

division of two gf(q)

void gf::operator= const int  inexp  ) 
 

gf(q) equals alpha^inexp

void gf::operator= const gf ingf  ) 
 

gf(q) equals ingf

int gf::operator== const gf ingf  )  const
 

Equality check.

void gf::set int  qvalue,
const bvec &  vectorspace
 

gf(q) equals the element that corresponds to the given vector space. The format is (...,c,b,a), where the element x is given as x=...+c*alpha^2+b*alpha+a.

void SPUC::gf::set int  qvalue,
int  inexp
[inline]
 

gf(q) equals alpha ^ inexp

Here is the call graph for this function:

void gf::set_size int  qvalue  ) 
 

set q=2^mvalue


Friends And Related Function Documentation

ostream& operator<< ostream &  os,
const gf ingf
[friend]
 

Output stream for gf(q).


The documentation for this class was generated from the following files:
Generated on Fri Sep 16 11:07:46 2005 for spuc by  doxygen 1.4.4