class Gambit::Printers::asciiReader

Derived EntryGetterInterface class for accessing asciiPrinter output points.

#include <asciireader.hpp>

Inherits from Gambit::Printers::BaseReader, Gambit::Printers::BaseBaseReader

Public Functions

Name
asciiReader(const Options & options)
General members of ‘asciiReader’.
virtual voidreset()
Base class virtual interface functions.
virtual ulongget_dataset_length()
Get total length of dataset.
virtual PPIDpairget_next_point()
Get next rank/ptID pair.
virtual PPIDpairget_current_point()
virtual ulongget_current_index()
virtual booleoi()
virtual std::size_tget_type(const std::string & )
virtual std::set< std::string >get_all_labels()
Get all output column labels.
template <typename T >
bool
_retrieve(T & , const std::string & label, const uint, const ulong)
Retrieval functions.

Additional inherited members

Public Functions inherited from Gambit::Printers::BaseReader

Name
BaseReader()
virtual~BaseReader()
Destructor.
template <typename T >
bool
retrieve(T & out, const std::string & label)
Reimplement overload for ‘retrieve’ that uses the current point as the input for rank/pointID.
template <typename T >
bool
retrieve(T & out, const std::string & label, const uint rank, const ulong pointID)
virtual boolretrieve_and_print(const std::string & in_label, const std::string & out_label, BaseBasePrinter & printer, const uint rank, const ulong pointID)
Retrieve and directly print data to new output.

Public Functions inherited from Gambit::Printers::BaseBaseReader

Name
virtual~BaseBaseReader()
template <typename T >
bool
retrieve(T & out, const std::string & label, const uint rank, const ulong pointID)
template <typename T >
bool
retrieve(T & out, const std::string & label)
Overload for ‘retrieve’ that uses the current point as the input for rank/pointID.
boolretrieve_and_print(const std::string & label, BaseBasePrinter & printer, const uint rank, const ulong pointID)
Retrieve and directly print data to new output.
virtual boolretrieve_and_print(const std::string & in_label, const std::string & out_label, BaseBasePrinter & printer, const uint rank, const ulong pointID) =0
boolretrieve_and_print(const std::string & label, BaseBasePrinter & printer)
Overload for ‘retrieve_and_print’ that uses the current point as the input for rank/pointID.
boolretrieve_and_print(const std::string & in_label, const std::string & out_label, BaseBasePrinter & printer)
As above, but allows for different input/output labels.

Public Functions Documentation

function asciiReader

asciiReader(
    const Options & options
)

General members of ‘asciiReader’.

Constructor

Open output data file

Scan through file and figure out how many points are in the dataset

function reset

virtual void reset()

Base class virtual interface functions.

Reimplements: Gambit::Printers::BaseBaseReader::reset

Reset read head position to zero.

Reset row count

function get_dataset_length

virtual ulong get_dataset_length()

Get total length of dataset.

Reimplements: Gambit::Printers::BaseBaseReader::get_dataset_length

function get_next_point

virtual PPIDpair get_next_point()

Get next rank/ptID pair.

Reimplements: Gambit::Printers::BaseBaseReader::get_next_point

function get_current_point

virtual PPIDpair get_current_point()

Reimplements: Gambit::Printers::BaseBaseReader::get_current_point

function get_current_index

virtual ulong get_current_index()

Reimplements: Gambit::Printers::BaseBaseReader::get_current_index

function eoi

virtual bool eoi()

Reimplements: Gambit::Printers::BaseBaseReader::eoi

function get_type

inline virtual std::size_t get_type(
    const std::string & 
)

Reimplements: Gambit::Printers::BaseBaseReader::get_type

Get type information for a data entry, i.e. defines the C++ type which this should be retrieved as, not what it is necessarily literally stored as in the output. For ASCIIPrinter, everything is currently a double.

function get_all_labels

virtual std::set< std::string > get_all_labels()

Get all output column labels.

Reimplements: Gambit::Printers::BaseBaseReader::get_all_labels

function _retrieve

template <typename T >
inline bool _retrieve(
    T & ,
    const std::string & label,
    const uint,
    const ulong
)

Retrieval functions.


Updated on 2023-06-26 at 21:36:52 +0000