Frobby 0.10.0
Loading...
Searching...
No Matches
InputConsumer Class Reference

Public Member Functions

void consumeRing (const VarNames &names)
void requireSquareFree ()
void beginIdeal ()
void hintGenCount (size_t hintGenCount)
void beginTerm ()
size_t consumeVar (Scanner &in)
size_t consumeVarNumber (Scanner &in)
void consumeVarExponentOne (size_t var, const Scanner &in)
void consumeVarExponent (size_t var, Scanner &in)
void endTerm ()
void consumeTermProductNotation (Scanner &in)
void endIdeal ()
bool empty () const
void releaseIdeal (unique_ptr< SquareFreeIdeal > &sqf, unique_ptr< BigIdeal > &big)
unique_ptr< BigIdeal > releaseBigIdeal ()
unique_ptr< SquareFreeIdeal > releaseSquareFreeIdeal ()
const VarNames & getRing () const

Member Function Documentation

◆ beginIdeal()

void InputConsumer::beginIdeal ( )

Start consuming an ideal.

◆ beginTerm()

void InputConsumer::beginTerm ( )

Start consuming a term.

◆ consumeTermProductNotation()

void InputConsumer::consumeTermProductNotation ( Scanner & in)

Reads a term in a format like "a^4*b*c^2"

◆ consumeVar()

size_t InputConsumer::consumeVar ( Scanner & in)

Reads variable and returns id. Does not return if there is an error.

◆ consumeVarExponent()

void InputConsumer::consumeVarExponent ( size_t var,
Scanner & in )

Consumes var raised to an exponent read from in.

Does not return if there is an error.

◆ consumeVarExponentOne()

void InputConsumer::consumeVarExponentOne ( size_t var,
const Scanner & in )

Consumes var raised to the exponent 1.

◆ consumeVarNumber()

size_t InputConsumer::consumeVarNumber ( Scanner & in)

Reads variable as a number so that the first variable is 1. Does not return if there is an error.

◆ empty()

bool InputConsumer::empty ( ) const
inline

Returns true if there are ideals stored.

◆ endIdeal()

void InputConsumer::endIdeal ( )

Done reading an ideal.

◆ endTerm()

void InputConsumer::endTerm ( )

Done reading a term.

◆ getRing()

const VarNames & InputConsumer::getRing ( ) const
inline

Returns the current ring.

◆ hintGenCount()

void InputConsumer::hintGenCount ( size_t hintGenCount)

Suggest that the current ideal will have the given number of generators. This helps in preallocating the right amount of memory.

◆ releaseBigIdeal()

unique_ptr< BigIdeal > InputConsumer::releaseBigIdeal ( )

Returns the least recently read ideal that has not been released. Converts the ideal to a BigIdeal if it had been read as something else.

◆ releaseIdeal()

void InputConsumer::releaseIdeal ( unique_ptr< SquareFreeIdeal > & sqf,
unique_ptr< BigIdeal > & big )

Struct that keeps either a BigIdeal or a SquareFreeIdeal. Assigns the least recently read ideal that has not been released to the parameter of the type that the ideal was read as.

◆ releaseSquareFreeIdeal()

unique_ptr< SquareFreeIdeal > InputConsumer::releaseSquareFreeIdeal ( )

Returns the least recently read ideal that has not been released. That ideal must have been read as a SquareFreeIdeal.


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