escript  Revision_
DataEmpty.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2017 by The University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Apache License, version 2.0
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16 
17 #ifndef __ESCRIPT_DATAEMPTY_H__
18 #define __ESCRIPT_DATAEMPTY_H__
19 
20 #include "system_dep.h"
21 #include "DataReady.h"
22 
23 namespace escript {
24 
33 class DataEmpty : public DataReady {
34 typedef DataReady parent;
35  public:
36 
46  DataEmpty();
47 
53  virtual
54  ~DataEmpty();
55 
61  virtual
62  std::string
63  toString() const;
64 
69  virtual
71  deepCopy() const;
72 
78  virtual
80  zeroedCopy() const;
81 
82 
92  virtual
94  getPointOffset(int sampleNo,
95  int dataPointNo) const;
96 
98  virtual
100  getPointOffset(int sampleNo,
101  int dataPointNo);
102 
109  virtual
111  getLength() const;
112 
121  virtual
122  DataAbstract*
123  getSlice(const DataTypes::RegionType& region) const;
124 
135  virtual
136  void
137  setSlice(const DataAbstract* value,
138  const DataTypes::RegionType& region);
139 
146  int
147  matrixInverse(DataAbstract* out) const;
148 
149  void
150  dump(const std::string fileName) const;
151 
153  bool
154  hasNaN() const
155  {
156  return false;
157  }
158 
160  void
162  {
163 
164  }
165 
167  void
169  {
170 
171  }
172 
173  protected:
174 
180  getVectorRW();
181 
182 
184  virtual const DataTypes::RealVectorType&
185  getVectorRO() const;
186 
189  getVectorRWC();
190 
191 
193  virtual const DataTypes::CplxVectorType&
194  getVectorROC() const;
195 
198 
199  virtual const DataTypes::RealVectorType&
200  getTypedVectorRO(DataTypes::real_t dummy) const;
201 
204 
205  virtual const DataTypes::CplxVectorType&
206  getTypedVectorRO(DataTypes::cplx_t dummy) const;
207 
208 
209  private:
210 
211 // /**
212 /* \brief
213  Throw a standard exception. This function is called if an attempt
214  is made to use functions of DataEmpty that are not valid.*/
215 // */
216 // void
217 // throwStandardException(const std::string& functionName) const;
218 
219 };
220 
221 } // end of namespace
222 
223 #endif // __ESCRIPT_DATAEMPTY_H__
224 
virtual void setSlice(const DataAbstract *value, const DataTypes::RegionType &region)
Set the current Data object according to the specified slice from the given input value...
Definition: DataEmpty.cpp:95
virtual DataAbstract * zeroedCopy() const
Return an object with the same type, domain (and tags if appropriate) as this, but all values are zer...
Definition: DataEmpty.cpp:60
virtual DataAbstract * getSlice(const DataTypes::RegionType &region) const
Factory method that returns a newly created DataEmpty sliced from the current Data object according t...
Definition: DataEmpty.cpp:88
Definition: DataReady.h:35
DataTypes::vec_size_type size_type
Definition: DataVectorAlt.h:49
std::vector< std::pair< int, int > > RegionType
Definition: DataTypes.h:43
Definition: AbstractContinuousDomain.cpp:22
virtual const DataTypes::RealVectorType & getVectorRO() const
Definition: DataEmpty.cpp:117
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataEmpty.cpp:147
Implements the DataAbstract interface for an empty Data object.
Definition: DataEmpty.h:33
virtual DataTypes::RealVectorType & getVectorRW()
Provide access to underlying storage. Internal use only!
Definition: DataEmpty.cpp:110
virtual std::string toString() const
Return a textual representation of the Data object.
Definition: DataEmpty.cpp:47
void replaceNaN(DataTypes::real_t value)
replaces all NaN values with value
Definition: DataEmpty.h:161
bool hasNaN() const
return true if data contains NaN.
Definition: DataEmpty.h:154
virtual ~DataEmpty()
Destructor for DataEmpty.
Definition: DataEmpty.cpp:42
void replaceNaN(DataTypes::cplx_t value)
replaces all NaN values with value
Definition: DataEmpty.h:168
virtual DataTypes::CplxVectorType & getVectorRWC()
Definition: DataEmpty.cpp:125
int matrixInverse(DataAbstract *out) const
invert square matricies
Definition: DataEmpty.cpp:102
virtual DataTypes::RealVectorType::size_type getPointOffset(int sampleNo, int dataPointNo) const
Return the offset for the given sample. NB: This will throw an exception as obviously an empty Data o...
Definition: DataEmpty.cpp:66
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:53
virtual DataTypes::RealVectorType::size_type getLength() const
Return the number of doubles stored for the Data object. As this is an empty Data object...
Definition: DataEmpty.cpp:82
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:29
Definition: DataAbstract.h:61
void dump(const std::string fileName) const
dumps the object into a netCDF file
Definition: DataEmpty.cpp:171
DataReady parent
Definition: DataEmpty.h:34
virtual DataTypes::RealVectorType & getTypedVectorRW(DataTypes::real_t dummy)
These versions use the type system rather than method name to determine return type.
Definition: DataEmpty.cpp:140
virtual DataAbstract * deepCopy() const
Return a deep copy of the current object.
Definition: DataEmpty.cpp:54
virtual const DataTypes::CplxVectorType & getVectorROC() const
Definition: DataEmpty.cpp:132
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:50
DataEmpty()
Default constructor for DataEmpty.
Definition: DataEmpty.cpp:36