TableBase Class Reference

#include <TableBase.h>

Inheritance diagram for TableBase:

Collaboration diagram for TableBase:

Public Member Functions
void	clearVec ()
void	compareVec (vector< double > other, string op)
void	compareXplot (string fname, string plotname, string op)
const vector< double > &	data ()
double	getOutputValue () const
string	getPlotDump () const
vector< double >	getVec () const
unsigned int	getVecSize () const
double	getY (unsigned int index) const
double	interpolate (double x, double xmin, double xmax) const
void	linearTransform (double scale, double offset)
void	loadCSV (string fname, int startLine, int colNum, char separator)
void	loadXplot (string fname, string plotname)
void	loadXplotRange (string fname, string plotname, unsigned int start, unsigned int end)
double *	lookupVec (unsigned int index)
void	plainPlot (string file)
void	setOutputValue (double val)
void	setPlotDump (string v)
void	setVec (vector< double > val)
void	setVecSize (unsigned int num)
	TableBase ()
void	xplot (string file, string plotname)

Static Public Member Functions
static const Cinfo *	initCinfo ()

Protected Member Functions
vector< double > &	vec ()

Private Attributes
double	output_
vector< double >	vec_

Detailed Description

Base class for table operations. Provides basics for looking up table and interpolation, but no process or messaging. Derived classes deal with these.

Definition at line 19 of file TableBase.h.

Constructor & Destructor Documentation

TableBase::TableBase

(

)

Definition at line 158 of file TableBase.cpp.

                     : output_( 0 )
{
}

Member Function Documentation

void TableBase::clearVec

(

)

Definition at line 414 of file TableBase.cpp.

References vec_.

Referenced by initCinfo(), Table::process(), Table::reinit(), Streamer::zipWithTime(), and Table::~Table().

{
    vec_.resize( 0 );
}

Here is the caller graph for this function:

void TableBase::compareVec	(	vector< double >	other,
		string	op
	)

Definition at line 395 of file TableBase.cpp.

References getRMSDiff(), getRMSRatio(), headop(), output_, and vec_.

Referenced by initCinfo().

{
    // Note that this line below is illegal: it causes a race condition
    // vector< double > temp = Field< vector< double > >::get( other, "vec" );

    string hop = headop( op );

    if ( hop == "rmsd" ) { // RMSDifference
        output_ = getRMSDiff( vec_, temp );
    }

    if ( hop == "rmsr" ) { // RMS ratio
        output_ = getRMSRatio( vec_, temp );
    }

    if ( hop == "dotp" )
        cout << "TableBase::compareVec: DotProduct not yet done\n";
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TableBase::compareXplot	(	string	fname,
		string	plotname,
		string	op
	)

Definition at line 374 of file TableBase.cpp.

References getRMSDiff(), getRMSRatio(), headop(), innerLoadXplot(), output_, and vec_.

Referenced by initCinfo().

{
    vector< double > temp;
    if ( !innerLoadXplot( fname, plotname, temp ) ) {
        cout << "TableBase::compareXplot: unable to load data from file " << fname <<endl;
    }

    string hop = headop( op );

    if ( hop == "rmsd" ) { // RMSDifference
        output_ = getRMSDiff( vec_, temp );
    }

    if ( hop == "rmsr" ) { // RMS ratio
        output_ = getRMSRatio( vec_, temp );
    }

    if ( hop == "dotp" )
        cout << "TableBase::compareXplot: DotProduct not yet done\n";
}

Here is the call graph for this function:

Here is the caller graph for this function:

const vector< double > & TableBase::data

(

)

Definition at line 498 of file TableBase.cpp.

References vec_.

Referenced by StreamerBase::writeToNPYFile().

{
    return vec_;
}

Here is the caller graph for this function:

double TableBase::getOutputValue

(

)

const

Definition at line 423 of file TableBase.cpp.

References output_.

Referenced by initCinfo().

{
    return output_;
}

Here is the caller graph for this function:

string TableBase::getPlotDump

(

)

const

Definition at line 503 of file TableBase.cpp.

Referenced by initCinfo().

{
    static string ret = "plot.Dump";
    return ret;
}

Here is the caller graph for this function:

vector< double > TableBase::getVec

(

)

const

Definition at line 482 of file TableBase.cpp.

References vec_.

Referenced by initCinfo(), and Streamer::zipWithTime().

{
    return vec_;
}

Here is the caller graph for this function:

unsigned int TableBase::getVecSize

(

)

const

Definition at line 477 of file TableBase.cpp.

References vec_.

Referenced by initCinfo(), Table::process(), and Streamer::process().

{
    return vec_.size();
}

Here is the caller graph for this function:

double TableBase::getY

(

unsigned int

index

)

const

Definition at line 433 of file TableBase.cpp.

References vec_.

Referenced by initCinfo().

{
    if ( index < vec_.size() )
        return ( vec_[index] );
    return 0;
}

Here is the caller graph for this function:

const Cinfo * TableBase::initCinfo ( )

static

Definition at line 15 of file TableBase.cpp.

References clearVec(), compareVec(), compareXplot(), getOutputValue(), getPlotDump(), getVec(), getVecSize(), getY(), Neutral::initCinfo(), linearTransform(), loadCSV(), loadXplot(), loadXplotRange(), plainPlot(), setPlotDump(), setVec(), tableCinfo, vec(), and xplot().

Referenced by TimeTable::initCinfo(), StimulusTable::initCinfo(), Table::initCinfo(), Streamer::initCinfo(), and Interpol::initCinfo().

{
        // Field Definitions
        static ValueFinfo< TableBase, vector< double > > vec(
            "vector",
            "vector with all table entries",
            &TableBase::setVec,
            &TableBase::getVec
        );

        static ValueFinfo< TableBase, string > plotDump(
            "plotDump",
            "'File plotname' for dumpling an xplot, as a workaround for an error in the xplot python interface. Note separator is a space. The return value is a dummy.",
            &TableBase::setPlotDump,
            &TableBase::getPlotDump
        );

        static ReadOnlyValueFinfo< TableBase, double > outputValue(
            "outputValue",
            "Output value holding current table entry or output of a calculation",
            &TableBase::getOutputValue
        );

        static ReadOnlyValueFinfo< TableBase, unsigned int > size(
            "size",
            "size of table. Note that this is the number of x divisions +1"
            "since it must represent the largest value as well as the"
            "smallest",
            &TableBase::getVecSize
        );

        static ReadOnlyLookupValueFinfo< TableBase, unsigned int, double > y(
            "y",
            "Value of table at specified index",
            &TableBase::getY
        );

        // MsgDest Definitions

                static DestFinfo linearTransform( "linearTransform",
                        "Linearly scales and offsets data. Scale first, then offset.",
                        new OpFunc2< TableBase, double, double >( &TableBase::linearTransform ) );

        static DestFinfo xplot( "xplot",
            "Dumps table contents to xplot-format file. "
            "Argument 1 is filename, argument 2 is plotname",
            new OpFunc2< TableBase, string, string >( &TableBase::xplot ) );

        static DestFinfo plainPlot( "plainPlot",
            "Dumps table contents to single-column ascii file. "
            "Uses scientific notation. "
            "Argument 1 is filename",
            new OpFunc1< TableBase, string >( &TableBase::plainPlot ) );

        static DestFinfo loadCSV( "loadCSV",
            "Reads a single column from a CSV file. "
            "Arguments: filename, column#, starting row#, separator",
            new OpFunc4< TableBase, string, int, int, char >(
                &TableBase::loadCSV ) );

        static DestFinfo loadXplot( "loadXplot",
            "Reads a single plot from an xplot file. "
            "Arguments: filename, plotname"
            "When the file has 2 columns, the 2nd column is loaded.",
            new OpFunc2< TableBase, string, string >(
                &TableBase::loadXplot ) );

        static DestFinfo loadXplotRange( "loadXplotRange",
            "Reads a single plot from an xplot file, and selects a "
            "subset of points from it. "
            "Arguments: filename, plotname, startindex, endindex"
            "Uses C convention: startindex included, endindex not included."
            "When the file has 2 columns, the 2nd column is loaded.",
            new OpFunc4< TableBase, string, string, unsigned int, unsigned int >(
                &TableBase::loadXplotRange ) );

        static DestFinfo compareXplot( "compareXplot",
            "Reads a plot from an xplot file and compares with contents of TableBase."
            "Result is put in 'output' field of table."
            "If the comparison fails (e.g., due to zero entries), the "
            "return value is -1."
            "Arguments: filename, plotname, comparison_operation"
            "Operations: rmsd (for RMSDifference), rmsr (RMSratio ), "
            "dotp (Dot product, not yet implemented).",
            new OpFunc3< TableBase, string, string, string >(
                &TableBase::compareXplot ) );

        static DestFinfo compareVec( "compareVec",
            "Compares contents of TableBase with a vector of doubles."
            "Result is put in 'output' field of table."
            "If the comparison fails (e.g., due to zero entries), the "
            "return value is -1."
            "Arguments: Other vector, comparison_operation"
            "Operations: rmsd (for RMSDifference), rmsr (RMSratio ), "
            "dotp (Dot product, not yet implemented).",
            new OpFunc2< TableBase, vector< double >, string >(
                &TableBase::compareVec ) );

                static DestFinfo clearVec(
                        "clearVec",
                        "Handles request to clear the data vector",
                        new OpFunc0< TableBase > (&TableBase::clearVec));


    static Finfo* tableBaseFinfos[] = {
        &vec,           // Value
        &plotDump,      // Value, used for debugging xplot function.
        &outputValue,   // ReadOnlyValue
        &size,          // ReadOnlyValue
        &y,             // ReadOnlyLookupValue
        &linearTransform,   // DestFinfo
        &xplot,         // DestFinfo
        &plainPlot,         // DestFinfo
        &loadCSV,           // DestFinfo
        &loadXplot,         // DestFinfo
        &loadXplotRange,    // DestFinfo
        &compareXplot,      // DestFinfo
        &compareVec,        // DestFinfo
                &clearVec,
    };

    static Dinfo< TableBase > dinfo;
    static Cinfo tableCinfo (
        "TableBase",
        Neutral::initCinfo(),
        tableBaseFinfos,
        sizeof( tableBaseFinfos ) / sizeof ( Finfo* ),
        &dinfo
    );

    return &tableCinfo;
}

Here is the call graph for this function:

Here is the caller graph for this function:

double TableBase::interpolate	(	double	x,
		double	xmin,
		double	xmax
	)		const

Definition at line 440 of file TableBase.cpp.

References vec_.

Referenced by StimulusTable::process(), Interpol::process(), and StimulusTable::reinit().

{
    if ( vec_.size() == 0 )
        return 0;
    if ( vec_.size() == 1 || input < xmin || xmin >= xmax )
        return vec_[0];
    if ( input > xmax )
        return ( vec_.back() );

    unsigned int xdivs = vec_.size() - 1;

    double fraction = ( input - xmin ) / ( xmax - xmin );
    if ( fraction < 0 )
        return vec_[0];

    unsigned int j = xdivs * fraction;
    if ( j >= ( vec_.size() - 1 ) )
        return vec_.back();

    double dx = (xmax - xmin ) / xdivs;
    double lowerBound = xmin + j * dx;
    double subFraction = ( input - lowerBound ) / dx;

    double y = vec_[j] + ( vec_[j + 1] - vec_[j] ) * subFraction;
    return y;
}

Here is the caller graph for this function:

void TableBase::linearTransform	(	double	scale,
		double	offset
	)

Definition at line 166 of file TableBase.cpp.

References vec_.

Referenced by initCinfo().

{
    for ( vector< double >::iterator i = vec_.begin(); i != vec_.end(); ++i)
        *i = *i * scale + offset;
}

Here is the caller graph for this function:

void TableBase::loadCSV	(	string	fname,
		int	startLine,
		int	colNum,
		char	separator
	)

Definition at line 320 of file TableBase.cpp.

Referenced by initCinfo().

{
    cout << "TODO: Not implemented yet" << endl;
}

Here is the caller graph for this function:

void TableBase::loadXplot	(	string	fname,
		string	plotname
	)

Definition at line 294 of file TableBase.cpp.

References innerLoadXplot(), and vec_.

Referenced by initCinfo().

{
    if ( !innerLoadXplot( fname, plotname, vec_ ) ) {
        cout << "TableBase::loadXplot: unable to load data from file " << fname <<endl;
        return;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TableBase::loadXplotRange	(	string	fname,
		string	plotname,
		unsigned int	start,
		unsigned int	end
	)

Definition at line 302 of file TableBase.cpp.

References innerLoadXplot(), and vec_.

Referenced by initCinfo().

{
    vector< double > temp;
    if ( !innerLoadXplot( fname, plotname, temp ) ) {
        cout << "TableBase::loadXplot: unable to load data from file " << fname <<endl;
        return;
    }
    if ( start > end || end > temp.size() ) {
        cout << "TableBase::loadXplotRange: Bad range (" << start <<
        ", " << end << "] for table of size " << temp.size() <<
        " from file " << fname << endl;
        return;
    }
    vec_.clear();
    vec_.insert( vec_.end(), temp.begin() + start, temp.begin() + end );
}

Here is the call graph for this function:

Here is the caller graph for this function:

double* TableBase::lookupVec

(

unsigned int

index

)

void TableBase::plainPlot

(

string

file

)

Definition at line 172 of file TableBase.cpp.

References vec_.

Referenced by initCinfo().

{
    ofstream fout( fname.c_str(), ios_base::out );
    fout.precision( 18 );
    fout.setf( ios::scientific, ios::floatfield );
    for ( vector< double >::iterator i = vec_.begin(); i != vec_.end(); ++i)
        fout << *i << endl;
    fout << "\n";
}

Here is the caller graph for this function:

void TableBase::setOutputValue

(

double

val

)

Definition at line 428 of file TableBase.cpp.

References output_.

Referenced by StimulusTable::process(), and StimulusTable::reinit().

{
    output_ = v;
}

Here is the caller graph for this function:

void TableBase::setPlotDump

(

string

v

)

Definition at line 509 of file TableBase.cpp.

References xplot().

Referenced by initCinfo().

{
    
    std::size_t pos = v.rfind(" ");
    string fname = v.substr( 0, pos );
    string plotname = "plot";
    if ( pos != string::npos )
        plotname = v.substr( pos );
    // cout << "setPlotDump( " << fname << ", " << plotname << " ),  " << v << "\n";
    xplot( fname, plotname );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TableBase::setVec

(

vector< double >

val

)

Definition at line 487 of file TableBase.cpp.

References vec_.

Referenced by initCinfo().

{
    vec_ = val;
}

Here is the caller graph for this function:

void TableBase::setVecSize

(

unsigned int

num

)

Definition at line 472 of file TableBase.cpp.

References vec_.

{
    vec_.resize( num );
}

vector< double > & TableBase::vec ( )

protected

Definition at line 492 of file TableBase.cpp.

References vec_.

Referenced by initCinfo(), Table::input(), TimeTable::process(), Table::process(), Table::reinit(), TimeTable::setFilename(), Table::spike(), and Table::~Table().

{
    return vec_;
}

Here is the caller graph for this function:

void TableBase::xplot	(	string	file,
		string	plotname
	)

Definition at line 182 of file TableBase.cpp.

References vec_.

Referenced by initCinfo(), and setPlotDump().

{
    ofstream fout( fname.c_str(), ios_base::app );
    fout << "/newplot\n";
    fout << "/plotname " << plotname << "\n";
    for ( vector< double >::iterator i = vec_.begin(); i != vec_.end(); ++i)
        fout << *i << endl;
    fout << "\n";
}

Here is the caller graph for this function:

Member Data Documentation

double TableBase::output_

private

Definition at line 72 of file TableBase.h.

Referenced by compareVec(), compareXplot(), getOutputValue(), and setOutputValue().

vector< double > TableBase::vec_

private

Definition at line 73 of file TableBase.h.

Referenced by clearVec(), compareVec(), compareXplot(), data(), getVec(), getVecSize(), getY(), interpolate(), linearTransform(), loadXplot(), loadXplotRange(), plainPlot(), setVec(), setVecSize(), vec(), and xplot().

---

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

• moose-core/builtins/TableBase.h
• moose-core/builtins/TableBase.cpp