#include <DataReady.h>

Inheritance diagram for escript::DataReady:

Public Member Functions
	DataReady (const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)
	~DataReady ()
ESCRIPT_DLL_API double *	getSampleDataRW (ValueType::size_type sampleNo)
	Return the sample data for the given sample number.
ESCRIPT_DLL_API const double *	getSampleDataRO (ValueType::size_type sampleNo) const
virtual ESCRIPT_DLL_API DataTypes::ValueType &	getVectorRW ()=0
	Provide access to underlying storage. Internal use only!
virtual ESCRIPT_DLL_API const DataTypes::ValueType &	getVectorRO () const =0
virtual ESCRIPT_DLL_API bool	hasNaN () const =0
	return true if data contains NaN.
virtual ESCRIPT_DLL_API void	setSlice (const DataAbstract *value, const DataTypes::RegionType &region)=0
	Copy the specified region from the given object.
ESCRIPT_DLL_API DataTypes::ValueType::const_reference	getDataAtOffsetRO (DataTypes::ValueType::size_type i) const
	get a reference to the beginning of a data point
ESCRIPT_DLL_API DataTypes::ValueType::reference	getDataAtOffsetRW (DataTypes::ValueType::size_type i)
ESCRIPT_DLL_API DataReady_ptr	resolve ()
	Return a data object with all points resolved.
Private Types
typedef DataAbstract	parent

Detailed Description

Base class for Data which do not need to be resolved. Internally this means they have getVectorRO and getVectorRW methods.

Member Typedef Documentation

typedef DataAbstract escript::DataReady::parent [private]

Reimplemented in escript::DataConstant, escript::DataEmpty, escript::DataExpanded, and escript::DataTagged.

Constructor & Destructor Documentation

escript::DataReady::DataReady	(	const FunctionSpace &	what,
		const ShapeType &	shape,
		bool	isDataEmpty = `false`
	)

escript::DataReady::~DataReady ( ) [inline]

Member Function Documentation

DataTypes::ValueType::const_reference escript::DataReady::getDataAtOffsetRO ( DataTypes::ValueType::size_type i ) const [inline]

get a reference to the beginning of a data point

References getVectorRO().

Referenced by escript::Data::getDataAtOffsetRO(), and escript::Data::getDataPointRO().

DataTypes::ValueType::reference escript::DataReady::getDataAtOffsetRW ( DataTypes::ValueType::size_type i ) [inline]

References getVectorRW().

Referenced by escript::Data::getDataAtOffsetRW(), and escript::Data::getDataPointRW().

const double * escript::DataReady::getSampleDataRO ( ValueType::size_type sampleNo ) const [inline]

References escript::DataAbstract::getPointOffset(), and getVectorRO().

Referenced by escript::Data::getSampleDataRO().

DataAbstract::ValueType::value_type * escript::DataReady::getSampleDataRW ( ValueType::size_type sampleNo ) [inline]

Return the sample data for the given sample number.

References escript::DataAbstract::getPointOffset(), and getVectorRW().

Referenced by escript::Data::getSampleDataRW().

virtual ESCRIPT_DLL_API const DataTypes::ValueType& escript::DataReady::getVectorRO ( ) const [pure virtual]

Implemented in escript::DataConstant, escript::DataEmpty, escript::DataExpanded, and escript::DataTagged.

Referenced by escript::binaryOp(), getDataAtOffsetRO(), getSampleDataRO(), escript::Data::interpolateFromTable1D(), escript::Data::interpolateFromTable2D(), escript::Data::interpolateFromTable3D(), and escript::Data::toListOfTuples().

virtual ESCRIPT_DLL_API DataTypes::ValueType& escript::DataReady::getVectorRW ( ) [pure virtual]

Provide access to underlying storage. Internal use only!

Implemented in escript::DataConstant, escript::DataEmpty, escript::DataExpanded, and escript::DataTagged.

Referenced by escript::Data::copyWithMask(), getDataAtOffsetRW(), getSampleDataRW(), escript::TestDomain::getX(), escript::Data::interpolateFromTable1D(), escript::Data::interpolateFromTable2D(), and escript::Data::interpolateFromTable3D().

virtual ESCRIPT_DLL_API bool escript::DataReady::hasNaN ( ) const [pure virtual]

return true if data contains NaN.

Warning:: This is dependent on the ability to reliably detect NaNs on your compiler. See the nancheck function in LocalOps for details.

Implemented in escript::DataConstant, escript::DataEmpty, escript::DataExpanded, and escript::DataTagged.

Referenced by escript::Data::infWorker(), escript::Data::LsupWorker(), and escript::Data::supWorker().

DataReady_ptr escript::DataReady::resolve ( ) [virtual]

Return a data object with all points resolved.

Implements escript::DataAbstract.

References escript::DataAbstract::getPtr().

virtual ESCRIPT_DLL_API void escript::DataReady::setSlice	(	const DataAbstract *	value,
		const DataTypes::RegionType &	region
	)			`[pure virtual]`

Copy the specified region from the given object.

Parameters:

	value	- Input - Data to copy from
	region	- Input - Region to copy.

Implemented in escript::DataConstant, escript::DataEmpty, escript::DataExpanded, and escript::DataTagged.

Referenced by escript::Data::setSlice().

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

escript::DataReady Class Reference

Public Member Functions

Private Types

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation