/[escript]/trunk/escript/src/DataLazy.h
ViewVC logotype

Diff of /trunk/escript/src/DataLazy.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

branches/schroedinger/escript/src/DataLazy.h revision 1903 by jfenwick, Wed Oct 22 06:11:01 2008 UTC trunk/escript/src/DataLazy.h revision 2177 by jfenwick, Wed Dec 17 23:51:23 2008 UTC
# Line 25  Line 25 
25    
26  namespace escript {  namespace escript {
27    
28    // For the purposes of unit testing and maintaining sanity, it is important that this enum be contiguous
29  enum ES_optype  enum ES_optype
30  {  {
31      UNKNOWNOP=0,      UNKNOWNOP=0,
# Line 33  enum ES_optype Line 34  enum ES_optype
34      SUB=3,      SUB=3,
35      MUL=4,      MUL=4,
36      DIV=5,      DIV=5,
37      SIN=6,      POW=6,
38      COS=7,      SIN=POW+1,
39      TAN=8,      COS=SIN+1,
40      ASIN=9,      TAN=SIN+2,
41      ACOS=10,      ASIN=SIN+3,
42      ATAN=11,      ACOS=SIN+4,
43      SINH=12,      ATAN=SIN+5,
44      COSH=13,      SINH=SIN+6,
45      TANH=14,      COSH=SIN+7,
46      ERF=15,      TANH=SIN+8,
47      ASINH=16,      ERF=SIN+9,
48      ACOSH=17,      ASINH=SIN+10,
49      ATANH=18,      ACOSH=SIN+11,
50      LOG10=19,      ATANH=SIN+12,
51      LOG=20,      LOG10=ATANH+1,
52      SIGN=21,      LOG=LOG10+1,
53      ABS=22,      SIGN=LOG10+2,
54      NEG=23,      ABS=LOG10+3,
55      POS=24,      NEG=LOG10+4,
56      EXP=25,      POS=LOG10+5,
57      SQRT=26,      EXP=LOG10+6,
58      RECIP=27,      SQRT=LOG10+7,
59      GZ=28,      RECIP=LOG10+8,
60      LZ=29,      GZ=RECIP+1,
61      GEZ=30,      LZ=GZ+1,
62      LEZ=31      GEZ=GZ+2,
63        LEZ=GZ+3,
64        NEZ=GZ+4,
65        EZ=GZ+5,
66        SYM=EZ+1,
67        NSYM=SYM+1,
68        PROD=NSYM+1,
69        TRANS=PROD+1,
70        TRACE=TRANS+1
71  };  };
72    
73    ESCRIPT_DLL_API
74  const std::string&  const std::string&
75  opToString(ES_optype op);  opToString(ES_optype op);
76    
# Line 106  public: Line 116  public:
116    DataLazy(DataAbstract_ptr left, ES_optype op);    DataLazy(DataAbstract_ptr left, ES_optype op);
117    
118    /**    /**
119      \brief Produce a DataLazy for a unary operation.
120      \param left DataAbstract to be operated on.
121      \param op unary operation to perform.
122      \param tol tolerance for operation
123      \throws DataException if op is not a unary operation or if p cannot be converted to a DataLazy.
124      Note that IDENTITY is not considered a unary operation.
125      */
126      ESCRIPT_DLL_API
127      DataLazy(DataAbstract_ptr left, ES_optype op, double tol);
128    
129      /**
130      \brief Produce a DataLazy for a unary operation which requires a parameter.
131      \param left DataAbstract to be operated on.
132      \param op unary operation to perform.
133      \param axis_offset the parameter for the operation
134      \throws DataException if op is not a unary operation or if p cannot be converted to a DataLazy.
135      Note that IDENTITY is not considered a unary operation.
136      */
137      ESCRIPT_DLL_API  
138      DataLazy(DataAbstract_ptr left, ES_optype op, int axis_offset);
139    
140    
141      /**
142    \brief Produce a DataLazy for a binary operation.    \brief Produce a DataLazy for a binary operation.
143    \param left left operand    \param left left operand
144    \param right right operand    \param right right operand
# Line 115  public: Line 148  public:
148    ESCRIPT_DLL_API    ESCRIPT_DLL_API
149    DataLazy(DataAbstract_ptr left, DataAbstract_ptr right, ES_optype op);    DataLazy(DataAbstract_ptr left, DataAbstract_ptr right, ES_optype op);
150    
151      /**
152      \brief Produce a DataLazy for a binary operation with additional paramters.
153      \param left left operand
154      \param right right operand
155      \param op unary operation to perform.
156      \param axis_offset
157      \param transpose  
158      \throws DataException if op is not a binary operation requiring parameters or if left or right cannot be converted to a DataLazy.
159      */
160      ESCRIPT_DLL_API
161      DataLazy(DataAbstract_ptr left, DataAbstract_ptr right, ES_optype op, int axis_offset, int transpose);
162    
163    ESCRIPT_DLL_API    ESCRIPT_DLL_API
164    ~DataLazy();    ~DataLazy();
165    
# Line 137  public: Line 182  public:
182    
183    /**    /**
184       \brief       \brief
185       Return the number of doubles that would be stored for this Data object if it were resolved.       This method throws an exception. It does not really make sense to ask this question of lazy data.
186    */    */
187    ESCRIPT_DLL_API    ESCRIPT_DLL_API
188    ValueType::size_type    ValueType::size_type
# Line 153  public: Line 198  public:
198    getPointOffset(int sampleNo,    getPointOffset(int sampleNo,
199                   int dataPointNo) const;                   int dataPointNo) const;
200    
201      DataTypes::ValueType::size_type
202      getPointOffset(int sampleNo,
203                     int dataPointNo);
204    
205    
206    /**    /**
207      \return the number of samples which need to be stored to evaluate the expression.      \return the number of samples which need to be stored to evaluate the expression.
# Line 162  public: Line 211  public:
211    getBuffsRequired() const;    getBuffsRequired() const;
212    
213    /**    /**
214        \return the largest samplesize required to evaluate the expression.
215      */
216      ESCRIPT_DLL_API
217      size_t
218      getMaxSampleSize() const;
219    
220    
221      /**
222       \brief Produces an IDENTITY DataLazy containing zero.       \brief Produces an IDENTITY DataLazy containing zero.
223       The result will have the same shape and functionspace as before.       The result will have the same shape and functionspace as before.
224    */    */
# Line 173  private: Line 230  private:
230    DataReady_ptr m_id;   //  For IDENTITY nodes, stores a wrapped value.    DataReady_ptr m_id;   //  For IDENTITY nodes, stores a wrapped value.
231    DataLazy_ptr m_left, m_right; // operands for operation.    DataLazy_ptr m_left, m_right; // operands for operation.
232    ES_optype m_op;   // operation to perform.    ES_optype m_op;   // operation to perform.
   size_t m_length;  // number of values represented by the operation  
233    
234    int m_buffsRequired;  // how many samples are required to evaluate this expression    int m_buffsRequired;  // how many samples are required to evaluate this expression
235    size_t m_samplesize;  // number of values required to store a sample    size_t m_samplesize;  // number of values required to store a sample
236    
237    char m_readytype; // E for expanded, T for tagged, C for constant    char m_readytype; // E for expanded, T for tagged, C for constant
238    
239      int m_axis_offset;    // required extra info for general tensor product
240      int m_transpose;
241      int m_SL, m_SM, m_SR; // computed properties used in general tensor product
242    
243      double m_tol;     // required extra info for <>0 and ==0
244    
245      size_t m_maxsamplesize;   // largest samplesize required by any node in the expression
246      size_t m_children;
247      size_t m_height;
248    
249    
250    /**    /**
251    Does the work for toString.    Does the work for toString.
# Line 206  private: Line 272  private:
272    collapseToReady();    collapseToReady();
273    
274    /**    /**
275      \brief resolve the expression can store it in the current node
276      The current node will be converted to an identity node.
277      */
278      void
279      resolveToIdentity();
280    
281      /**
282      \brief helper method for resolveToIdentity and the identity constructor
283      */
284      void
285      makeIdentity(const DataReady_ptr& p);
286    
287      /**
288    \brief Compute the value of the expression for the given sample.    \brief Compute the value of the expression for the given sample.
289    \return Vector which stores the value of the subexpression for the given sample.    \return Vector which stores the value of the subexpression for the given sample.
290    \param v A vector to store intermediate results.    \param v A vector to store intermediate results.
# Line 219  private: Line 298  private:
298    resolveSample(ValueType& v,  size_t offset ,int sampleNo, size_t& roffset);    resolveSample(ValueType& v,  size_t offset ,int sampleNo, size_t& roffset);
299    
300    /**    /**
301    \brief Compute the value of the expression (binary operation) for the given sample.    \brief Compute the value of the expression (unary operation) for the given sample.
302    \return Vector which stores the value of the subexpression for the given sample.    \return Vector which stores the value of the subexpression for the given sample.
303    \param v A vector to store intermediate results.    \param v A vector to store intermediate results.
304    \param offset Index in v to begin storing results.    \param offset Index in v to begin storing results.
# Line 234  private: Line 313  private:
313    resolveUnary(ValueType& v,  size_t offset,int sampleNo,  size_t& roffset) const;    resolveUnary(ValueType& v,  size_t offset,int sampleNo,  size_t& roffset) const;
314    
315    /**    /**
316      \brief Compute the value of the expression (unary non-pointwise operation) for the given sample.
317      \return Vector which stores the value of the subexpression for the given sample.
318      \param v A vector to store intermediate results.
319      \param offset Index in v to begin storing results.
320      \param sampleNo Sample number to evaluate.
321      \param roffset (output parameter) the offset in the return vector where the result begins.
322    
323      The return value will be an existing vector so do not deallocate it.
324      If the result is stored in v it should be stored at the offset given.
325      Everything from offset to the end of v should be considered available for this method to use.
326    
327      This method differs from the one above in that deals with operations that are not
328      point-wise. That is, the answer cannot just be written on top of the input.
329      Extra buffers are required for these operations.
330      */
331    
332      ValueType*
333      resolveNP1OUT(ValueType& v, size_t offset, int sampleNo, size_t& roffset) const;
334    
335    /**
336      \brief Compute the value of the expression (unary operation) for the given sample.
337      \return Vector which stores the value of the subexpression for the given sample.
338      \param v A vector to store intermediate results.
339      \param offset Index in v to begin storing results.
340      \param sampleNo Sample number to evaluate.
341      \param roffset (output parameter) the offset in the return vector where the result begins.
342    
343      The return value will be an existing vector so do not deallocate it.
344      If the result is stored in v it should be stored at the offset given.
345      Everything from offset to the end of v should be considered available for this method to use.
346    */
347    DataTypes::ValueType*
348    resolveNP1OUT_P(ValueType& v, size_t offset, int sampleNo, size_t& roffset) const;
349    
350    
351      /**
352    \brief Compute the value of the expression (binary operation) for the given sample.    \brief Compute the value of the expression (binary operation) for the given sample.
353    \return Vector which stores the value of the subexpression for the given sample.    \return Vector which stores the value of the subexpression for the given sample.
354    \param v A vector to store intermediate results.    \param v A vector to store intermediate results.
# Line 248  private: Line 363  private:
363    ValueType*    ValueType*
364    resolveBinary(ValueType& v,  size_t offset,int sampleNo,  size_t& roffset) const;    resolveBinary(ValueType& v,  size_t offset,int sampleNo,  size_t& roffset) const;
365    
366      /**
367      \brief Compute the value of the expression (tensor product) for the given sample.
368      \return Vector which stores the value of the subexpression for the given sample.
369      \param v A vector to store intermediate results.
370      \param offset Index in v to begin storing results.
371      \param sampleNo Sample number to evaluate.
372      \param roffset (output parameter) the offset in the return vector where the result begins.
373    
374      The return value will be an existing vector so do not deallocate it.
375      If the result is stored in v it should be stored at the offset given.
376      Everything from offset to the end of v should be considered available for this method to use.
377      */
378      DataTypes::ValueType*
379      resolveTProd(ValueType& v,  size_t offset, int sampleNo, size_t& roffset) const;
380    
381  };  };
382    
383  }  }

Legend:
Removed from v.1903  
changed lines
  Added in v.2177

  ViewVC Help
Powered by ViewVC 1.1.26