MLAPI::MATLABStream Class Reference

Basic stream to save in a MATLAB-compatible file MLAPI objects. More...

#include <MLAPI_MATLABStream.h>

Public Member Functions
	MATLABStream (const std::string &FileName, bool UseSparse=true)
	Opens the specified file for writing.
	~MATLABStream ()
	Finally closes the output file.
MATLABStream &	operator<< (const int obj)
	Writes on file the specified integer (on process 0 only).
MATLABStream &	operator<< (const double obj)
	Writes on file the specified double (on process 0 only).
MATLABStream &	operator<< (const std::string obj)
	Writes on file the specified std::string on process 0 only.
MATLABStream &	operator<< (const Operator &obj)
	Writes on file input Operator, one process at-a-time, using global ordering.
MATLABStream &	operator<< (const MultiVector &obj)
	Writes on file the input MultiVector, one process at-a-time.
MATLABStream &	operator<< (const Space &obj)
	Writes on file input Space, one process at-a-time.
bool	GetUseSparse () const
	Returns true if the stream uses sparse MATLAB format.
void	SetUseSparse (const bool UseSparse)
	Toggles the use of sparse MATLAB formats.
std::string	GetFileName () const
	Returns the name of the output file.

Detailed Description

Basic stream to save in a MATLAB-compatible file MLAPI objects.

For an example of usage, see BlackBoard.cpp

Author

Marzio Sala, SNL 9214

Date

Last updated on Feb-05.

Constructor & Destructor Documentation

MATLABStream()

MLAPI::MATLABStream::MATLABStream ( const std::string & FileName, bool UseSparse = true )

inline

Opens the specified file for writing.

References MLAPI::GetMyPID(), and SetUseSparse().

Referenced by operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), and operator<<().

~MATLABStream()

MLAPI::MATLABStream::~MATLABStream ( )

inline

Finally closes the output file.

References MLAPI::GetMyPID().

Member Function Documentation

GetUseSparse()

bool MLAPI::MATLABStream::GetUseSparse ( ) const

inline

Returns true if the stream uses sparse MATLAB format.

Referenced by operator<<().

operator<<() [1/6]

MATLABStream & MLAPI::MATLABStream::operator<< ( const double obj )

inline

Writes on file the specified double (on process 0 only).

References MLAPI::GetMyPID(), and MATLABStream().

operator<<() [2/6]

MATLABStream & MLAPI::MATLABStream::operator<< ( const int obj )

inline

Writes on file the specified integer (on process 0 only).

References MLAPI::GetMyPID(), and MATLABStream().

operator<<() [3/6]

MATLABStream & MLAPI::MATLABStream::operator<< ( const MultiVector & obj )

inline

Writes on file the input MultiVector, one process at-a-time.

References MLAPI::Barrier(), MLAPI::BaseObject::GetLabel(), MLAPI::GetMyPID(), MLAPI::Space::GetNumGlobalElements(), MLAPI::Space::GetNumMyElements(), MLAPI::GetNumProcs(), MLAPI::MultiVector::GetNumVectors(), MLAPI::MultiVector::GetVectorSpace(), and MATLABStream().

operator<<() [4/6]

MATLABStream & MLAPI::MATLABStream::operator<< ( const Operator & obj )

inline

Writes on file input Operator, one process at-a-time, using global ordering.

References MLAPI::Barrier(), MLAPI::Operator::GetDomainSpace(), MLAPI::Operator::GetGCID(), MLAPI::Operator::GetGRID(), MLAPI::BaseObject::GetLabel(), MLAPI::Operator::GetML_Operator(), MLAPI::GetMyPID(), MLAPI::Space::GetNumGlobalElements(), MLAPI::GetNumProcs(), MLAPI::Operator::GetRangeSpace(), GetUseSparse(), and MATLABStream().

operator<<() [5/6]

MATLABStream & MLAPI::MATLABStream::operator<< ( const Space & obj )

inline

Writes on file input Space, one process at-a-time.

References MLAPI::Barrier(), MLAPI::BaseObject::GetLabel(), MLAPI::GetMyPID(), MLAPI::Space::GetNumGlobalElements(), MLAPI::Space::GetNumMyElements(), MLAPI::GetNumProcs(), and MATLABStream().

operator<<() [6/6]

MATLABStream & MLAPI::MATLABStream::operator<< ( const std::string obj )

inline

Writes on file the specified std::string on process 0 only.

References MLAPI::GetMyPID(), and MATLABStream().

SetUseSparse()

void MLAPI::MATLABStream::SetUseSparse ( const bool UseSparse )

inline

Toggles the use of sparse MATLAB formats.

Referenced by MATLABStream().

---

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

• MLAPI_MATLABStream.h