Utility class that can be used to read different kind of data from a file. More...

#include <latticetester/ParamReader.h>

Public Member Functions
	ParamReader ()
	Empty constructor.

	ParamReader (std::string fileName)
	Constructor.

	~ParamReader ()
	Destructor.

void	getLines ()
	Reads all the lines from the file and stores them into this object’s buffer.

void	readString (std::string &field, uint64_t ln, uint64_t pos)
	Reads a string from the `pos`-th token of the `ln`-th line into `field`.

void	readBool (bool &field, uint64_t ln, uint64_t pos)
	Reads a boolean from the `pos`-th token of the `ln`-th line into `field`.

void	readChar (char &field, uint64_t ln, uint64_t pos)
	Reads a character from the `pos`-th token of the `ln`-th line into `field`.

void	readInt (int64_t &field, uint64_t ln, uint64_t pos)
	Reads an integer from the `pos`-th token of the `ln`-th line into `field`.

void	readLong (std::int64_t &field, uint64_t ln, uint64_t pos)
	Reads a std::int64_t from the `pos`-th token of the `ln`-th line into `field`.

void	readZZ (NTL::ZZ &field, uint64_t ln, int64_t pos)
	Reads a large integer from the `pos`-th token of the `ln`-th line into `field`.

void	readDouble (double &field, uint64_t ln, uint64_t pos)
	Reads a double from the `pos`-th token of the `ln`-th line into `field`.

void	readNumber3 (Int &r, std::int64_t &b, std::int64_t &e, std::int64_t &c, uint64_t ln, uint64_t pos)
	Reads \(b\), \(e\) and \(c\), starting at the `pos`-th token of the `ln`-th line and uses them to define \(r\).

void	readBScal (Int &field, uint64_t ln, int64_t pos)
	Reads a `BScal` from the `pos`-th token of the `ln`-th line into `field`.

void	readBMat (IntMat &fields, uint64_t &ln, uint64_t pos, uint64_t numPos, uint64_t numCols)
	Reads a square `BMat` of size `numPos*numPos` from the `pos`-th token of the `ln`-th line into `field`.

void	readBMat (IntMat &fields, uint64_t &ln, uint64_t pos, uint64_t numPos)
	Reads a square `BMat` of size `numPos*numPos` from the `pos`-th token of the `ln`-th line into `field`.

void	readMScal (Int &field, uint64_t ln, uint64_t pos)
	Reads a `Int` from the `pos`-th token of the `ln`-th line into `field`.

void	readReal (Real &field, uint64_t ln, uint64_t pos)
	Reads a `Real` from the `pos`-th token of the `ln`-th line into `field`.

void	readMVect (IntVec &field, uint64_t &ln, uint64_t pos, uint64_t num, int64_t j)
	Reads `num` tokens (from the `pos`-th token of the `ln`-th line) into `field`, starting at index \(j\) of `field`.

void	readIntVect (int64_t *field, uint64_t ln, uint64_t pos, uint64_t num, int64_t j)
	Reads `num` tokens (from the `pos`-th token of the `ln`-th line) into `field`, starting at index \(j\) of `field`.

void	readDoubleVect (double *field, uint64_t ln, uint64_t pos, uint64_t num, int64_t j)
	Reads `num` tokens (from the `pos`-th token of the `ln`-th line) into `field`, starting at index \(j\) of `field`.

void	readNormType (NormType &field, uint64_t ln, uint64_t pos)
	Reads `2k MScal` tokens into vectors `B` and `C`, starting at the `ln`-th line.

void	readProblemType (ProblemType &field, uint64_t ln, uint64_t pos)
	Reads a problem type from the `pos`-th token of the `ln`-th line into `field`.

void	readCriterionType (CriterionType &field, uint64_t ln, uint64_t pos)
	Reads a test type from the `pos`-th token of the `ln`-th line into `field`.

void	readNormaType (NormaType &field, uint64_t ln, uint64_t pos)
	Reads a type of normalization from the `pos`-th token of the `ln`-th line into `field`.

void	readPrecisionType (PrecisionType &field, uint64_t ln, uint64_t pos)
	Reads a type of precision from the `pos`-th token of the `ln`-th line into `field`.

void	readReduct (ReductionType &field, uint64_t ln, uint64_t pos)
	Reads a type of ReductionType from the `pos`-the token of the `ln`-th line into `field`.

void	readOutputType (OutputType &field, uint64_t ln, uint64_t pos)
	Reads an output form from the `pos`-th token of the `ln`-th line into `field`.

void	read (Config< Int, IntMat > &config)
	Reads the configuration file into `config`.

Static Public Attributes
static const int64_t	MAX_WORD_SIZE = 64

Protected Member Functions
void	getToken (std::string &field, uint64_t ln, uint64_t pos)
	Puts into `field` the `pos`-th string token from line `ln`.

void	readBasisConfig (Config< Int, IntMat > &config, uint64_t &ln)
	This can be called to read a basis construction configuration from the file starting from `ln` (without the `BASIS` line).

void	readDualConfig (Config< Int, IntMat > &config, uint64_t &ln)
	This can be called to read a dual computation configuration from the file starting from `ln` (without the `DUAL` line).

void	readReductionConfig (Config< Int, IntMat > &config, uint64_t &ln)
	This can be called to read a reduction problem configuration from the file starting from `ln` (without the `REDUCT` line).

void	readShortestConfig (Config< Int, IntMat > &config, uint64_t &ln)
	This can be called to read a shortest vector problem configuration from the file starting from `ln` (without the `SHORTEST` line).

void	readMeritConfig (Config< Int, IntMat > &config, uint64_t &ln)
	This can be called to read a figure of merit computation configuration from the file starting from `ln` (without the `MERIT` line).

Detailed Description

template<typename Int, typename Real>
class LatticeTester::ParamReader< Int, Real >

Utility class that can be used to read different kind of data from a file.

This class has to be initialized with a fileName to be used. After the object is initialized, it is then necessary to read the entire file with getLines. This will make a vector containing all the lines of the file, removing those with a # at the start. There then are many methods allowing the conversion of string tokens to various data types by specifying a line and a token number. In every line, a token is a string delimited by any of these caracters: (blank), ?, !, ,, \t, and \n. For example, ReadString(string, 2, 3) will put the 4th token (numerotation starts at 0) of the 3rd line in string. The user of this class has to be aware of the format of the file that will be read.

Remarks: This class should have proper error management in the GetToken method because the program curently simply crashes without explanation if this class is misued.