escript  Revision_Unversioneddirectory
Public Member Functions | Private Types | List of all members
escript::DataReady Class Referenceabstract

#include <DataReady.h>

Inheritance diagram for escript::DataReady:
escript::DataAbstract escript::DataConstant escript::DataEmpty escript::DataExpanded escript::DataTagged

Public Member Functions

 DataReady (const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)
 
 ~DataReady ()
 
double * getSampleDataRW (ValueType::size_type sampleNo)
 Return the sample data for the given sample number. More...
 
const double * getSampleDataRO (ValueType::size_type sampleNo) const
 
virtual DataTypes::ValueTypegetVectorRW ()=0
 Provide access to underlying storage. Internal use only! More...
 
virtual const DataTypes::ValueTypegetVectorRO () const =0
 
virtual bool hasNaN () const =0
 return true if data contains NaN. More...
 
virtual void replaceNaN (double value)=0
 replaces all NaN values with value More...
 
virtual void setSlice (const DataAbstract *value, const DataTypes::RegionType &region)=0
 Copy the specified region from the given object. More...
 
DataTypes::ValueType::const_reference getDataAtOffsetRO (DataTypes::ValueType::size_type i) const
 get a reference to the beginning of a data point More...
 
DataTypes::ValueType::reference getDataAtOffsetRW (DataTypes::ValueType::size_type i)
 
DataReady_ptr resolve ()
 Return a data object with all points resolved. More...
 
- Public Member Functions inherited from escript::DataAbstract
DataAbstract_ptr getPtr ()
 Return shared pointer managing this object. More...
 
const_DataAbstract_ptr getPtr () const
 
 DataAbstract (const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)
 Constructor for DataAbstract. More...
 
virtual ~DataAbstract ()
 Destructor for DataAbstract. More...
 
virtual std::string toString () const =0
 Write the data as a string. More...
 
virtual DataAbstractdeepCopy ()=0
 Return a deep copy of the current object. More...
 
virtual void dump (const std::string fileName) const
 dumps the object into a netCDF file More...
 
int getNumDPPSample () const
 Return the number of data points per sample. More...
 
int getNumSamples () const
 Return the number of samples. More...
 
const DataTypes::ShapeTypegetShape () const
 Return the shape information for the point data. More...
 
unsigned int getRank () const
 Return the rank information for the point data. More...
 
virtual ValueType::size_type getPointOffset (int sampleNo, int dataPointNo) const =0
 Return the offset for the given sample. This returns the offset for the given point into the container holding the point data. More...
 
virtual ValueType::size_type getPointOffset (int sampleNo, int dataPointNo)=0
 
virtual ValueType::size_type getLength () const =0
 Return the number of doubles stored for this Data object. More...
 
virtual double * getSampleDataByTag (int tag)
 Return the sample data for the given tag key. NB: If the data isn't tagged an exception will be thrown. More...
 
virtual size_t getTagCount () const
 Return number of tagged values stored in the data object. More...
 
void operandCheck (const DataAbstract &right) const
 Check this and the given RHS operands are compatible. Throws an exception if they aren't. More...
 
bool validSamplePointNo (int samplePointNo) const
 Return true if a valid sample point number. More...
 
bool validSampleNo (int sampleNo) const
 Return true if a valid sample number. More...
 
const FunctionSpacegetFunctionSpace () const
 Return the function space associated with this Data object. More...
 
virtual DataAbstractgetSlice (const DataTypes::RegionType &region) const =0
 Return the given slice from this object. More...
 
virtual void setTaggedValue (int tagKey, const DataTypes::ShapeType &pointshape, const DataTypes::ValueType &value, int dataOffset=0)
 setTaggedValue More...
 
virtual void copyToDataPoint (const int sampleNo, const int dataPointNo, const double value)
 Copy a double value to the data point dataPointNo of sample sampleNo in this object. More...
 
virtual void copyToDataPoint (const int sampleNo, const int dataPointNo, const WrappedArray &value)
 Copy the array object to the data point dataPointNo of sample sampleNo in this object. More...
 
virtual int getTagNumber (int dpno)
 Return the tag number associated with the given data-point number. More...
 
virtual void symmetric (DataAbstract *ev)
 Computes a symmetric matrix (A + AT) / 2. More...
 
virtual void nonsymmetric (DataAbstract *ev)
 Computes a nonsymmetric matrix (A - AT) / 2. More...
 
virtual void trace (DataAbstract *ev, int axis_offset)
 Computes the trace of a matrix. More...
 
virtual void transpose (DataAbstract *ev, int axis_offset)
 Transpose each data point of this Data object around the given axis. More...
 
virtual void swapaxes (DataAbstract *ev, int axis0, int axis1)
 swaps components axis0 and axis1 More...
 
virtual void eigenvalues (DataAbstract *ev)
 solves the eigenvalue problem this*V=ev*V for the eigenvalues ev More...
 
virtual int matrixInverse (DataAbstract *out) const
 invert square matricies More...
 
virtual void setToZero ()
 sets values to zero More...
 
virtual void eigenvalues_and_eigenvectors (DataAbstract *ev, DataAbstract *V, const double tol=1.e-13)
 solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V More...
 
virtual void reorderByReferenceIDs (dim_t *reference_ids)
 reorders data sample ordered by reference_ids to the ordering of the functions space More...
 
unsigned int getNoValues () const
 Return the number of values in the shape for this object. More...
 
bool isLazy () const
 
virtual bool isConstant () const
 
virtual bool isExpanded () const
 
virtual bool actsExpanded () const
 Return true if this Data is expanded or resolves to expanded. That is, if it has a separate value for each datapoint in the sample. More...
 
virtual bool isTagged () const
 
bool isEmpty () const
 
void addOwner (Data *)
 
void removeOwner (Data *)
 
bool isShared () const
 Is this object owned by more than one Data object. More...
 

Private Types

typedef DataAbstract parent
 

Additional Inherited Members

- Public Types inherited from escript::DataAbstract
typedef DataTypes::ValueType ValueType
 
typedef DataTypes::ShapeType ShapeType
 
- Protected Member Functions inherited from escript::DataAbstract
bool checkNoSharing () const
 Returns true if this object is not shared. For internal use only. - It may not be particularly fast. More...
 
void makeLazyShared ()
 Marks this DataAbstract shared as LazyData For internal use only. More...
 
- Protected Attributes inherited from escript::DataAbstract
std::vector< Data * > m_owners
 
bool m_lazyshared
 

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

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(), escript::Data::getDataPointRO(), and ~DataReady().

DataTypes::ValueType::reference escript::DataReady::getDataAtOffsetRW ( DataTypes::ValueType::size_type  i)
inline
const double * escript::DataReady::getSampleDataRO ( ValueType::size_type  sampleNo) const
inline
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(), and ~DataReady().

virtual const DataTypes::ValueType& escript::DataReady::getVectorRO ( ) const
pure virtual
virtual DataTypes::ValueType& escript::DataReady::getVectorRW ( )
pure virtual
virtual 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::DataExpanded, escript::DataTagged, escript::DataEmpty, and escript::DataConstant.

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

virtual void escript::DataReady::replaceNaN ( double  value)
pure virtual

replaces all NaN values with value

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

Referenced by escript::Data::replaceNaN(), and ~DataReady().

DataReady_ptr escript::DataReady::resolve ( )
virtual

Return a data object with all points resolved.

Implements escript::DataAbstract.

References escript::DataAbstract::getPtr().

Referenced by ~DataReady().

virtual 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::DataTagged, escript::DataExpanded, escript::DataConstant, and escript::DataEmpty.

Referenced by escript::Data::setSlice(), and ~DataReady().


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