OneInvariantFactor Class Template Reference

#include <one-invariant-factor.h>

---

Detailed Description

template<class _Ring, class _LastInvariantFactor, class _Compose, class _RandomMatrix>
class LinBox::OneInvariantFactor< _Ring, _LastInvariantFactor, _Compose, _RandomMatrix >

Limited doc so far.

Public Types
typedef _LastInvariantFactor	LastInvariantFactor
typedef _Ring	Ring
typedef _Compose	Compose
typedef _RandomMatrix	RandomMatrix
typedef Ring::Element	Integer
Public Member Functions
	OneInvariantFactor (const Ring &_r=Ring(), const LastInvariantFactor &_lif=LastInvariantFactor(), const Compose &_compose=Compose(), const RandomMatrix &_randomMatrix=RandomMatrix(), int _threshold=DEFAULTOIFTHRESHOLD)
void	setThreshold (int _threshold)
int	getThreshold () const
void	setCrossover (double t)
double	getCrossover () const
LastInvariantFactor &	getLastInvariantFactor ()
const LastInvariantFactor &	getLastInvariantFactor () const
template<class IMatrix, class Vector> Integer &	oneInvariantFactor (Integer &oif, const IMatrix &A, int i, Vector &PrimeL) const
	Compute the i-th invariant factor of A, ignoring those factors of prime in PrimeL list. It implements EGV++ (by bds), the adaptive algorithm of EGV and EGV+.
template<class IMatrix> Integer &	oneInvariantFactor (Integer &oif, const IMatrix &A, int i) const
	Compute the i-th invariant factor of A. It implements the adaptive algorithm of EGV and EGV+.
template<class IMatrix, class Vector> Integer &	oneInvariantFactor_Bonus (Integer &oif, Integer &bonus, const IMatrix &A, int i, Vector &PrimeL) const
	Compute the i-th invariant factor of A with bonus, ignoring those factors of prime in PrimeL list. It implements EGV++ (by bds), the adaptive algorithm of EGV and EGV+.
template<class IMatrix> Integer &	oneInvariantFactor_Bonus (Integer &oif, Integer &bonus, const IMatrix &A, int i) const
	Compute the i-th invariant factor of A. It implements the adaptive algorithm of EGV and EGV+.
Protected Attributes
Ring	r
LastInvariantFactor	lif
Compose	compose
RandomMatrix	randomMatrix
int	threshold
double	crossover

---

Member Typedef Documentation

typedef _LastInvariantFactor LastInvariantFactor

typedef _Ring Ring

typedef _Compose Compose

typedef _RandomMatrix RandomMatrix

typedef Ring::Element Integer

---

Constructor & Destructor Documentation

OneInvariantFactor (  const Ring &  _r = Ring(), const LastInvariantFactor &  _lif = LastInvariantFactor(), const Compose &  _compose = Compose(), const RandomMatrix &  _randomMatrix = RandomMatrix(), int  _threshold = DEFAULTOIFTHRESHOLD )  [inline]

---

Member Function Documentation

void setThreshold (  int  _threshold  )  [inline]

int getThreshold (   )  const [inline]

void setCrossover (  double  t  )  [inline]

double getCrossover (   )  const [inline]

LastInvariantFactor& getLastInvariantFactor (   )  [inline]

const LastInvariantFactor& getLastInvariantFactor (   )  const [inline]

Integer& oneInvariantFactor (  Integer &  oif, const IMatrix &  A, int  i, Vector &  PrimeL )  const [inline]

Compute the i-th invariant factor of A, ignoring those factors of prime in PrimeL list. It implements EGV++ (by bds), the adaptive algorithm of EGV and EGV+.

Integer& oneInvariantFactor (  Integer &  oif, const IMatrix &  A, int  i )  const [inline]

Compute the i-th invariant factor of A. It implements the adaptive algorithm of EGV and EGV+.

Integer& oneInvariantFactor_Bonus (  Integer &  oif, Integer &  bonus, const IMatrix &  A, int  i, Vector &  PrimeL )  const [inline]

Compute the i-th invariant factor of A with bonus, ignoring those factors of prime in PrimeL list. It implements EGV++ (by bds), the adaptive algorithm of EGV and EGV+.

Integer& oneInvariantFactor_Bonus (  Integer &  oif, Integer &  bonus, const IMatrix &  A, int  i )  const [inline]

Compute the i-th invariant factor of A. It implements the adaptive algorithm of EGV and EGV+.

---

Field Documentation

Ring r [protected]

LastInvariantFactor lif [protected]

Compose compose [protected]

RandomMatrix randomMatrix [protected]

int threshold [protected]

double crossover [protected]

---