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

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

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

trunk/esys2/escript/src/Data/Data.h revision 119 by jgs, Tue Apr 12 04:45:05 2005 UTC trunk/escript/src/Data.h revision 969 by ksteube, Tue Feb 13 23:02:23 2007 UTC
# Line 1  Line 1 
1  // $Id$  // $Id$
2  /*=============================================================================  /*
3     ************************************************************
4   ******************************************************************************   *          Copyright 2006 by ACcESS MNRF                   *
5   *                                                                            *   *                                                          *
6   *       COPYRIGHT ACcESS 2004 -  All Rights Reserved                         *   *              http://www.access.edu.au                    *
7   *                                                                            *   *       Primary Business: Queensland, Australia            *
8   * This software is the property of ACcESS.  No part of this code             *   *  Licensed under the Open Software License version 3.0    *
9   * may be copied in any form or by any means without the expressed written    *   *     http://www.opensource.org/licenses/osl-3.0.php       *
10   * consent of ACcESS.  Copying, use or modification of this software          *   *                                                          *
11   * by any unauthorised person is illegal unless that                          *   ************************************************************
12   * person has a software license agreement with ACcESS.                       *  */
  *                                                                            *  
  ******************************************************************************  
13    
14  ******************************************************************************/  /** \file Data.h */
15    
16  #ifndef DATA_H  #ifndef DATA_H
17  #define DATA_H  #define DATA_H
18    #include "system_dep.h"
19    
20  #include "escript/Data/DataAbstract.h"  #include "DataAbstract.h"
21  #include "escript/Data/DataTagged.h"  #include "DataAlgorithm.h"
22  #include "escript/Data/FunctionSpace.h"  #include "FunctionSpace.h"
23  #include "escript/Data/BinaryOp.h"  #include "BinaryOp.h"
24  #include "escript/Data/UnaryOp.h"  #include "UnaryOp.h"
25  #include "escript/Data/DataException.h"  #include "DataException.h"
26    
27  extern "C" {  extern "C" {
28  #include "escript/Data/DataC.h"  #include "DataC.h"
29    /* #include "paso/Paso.h" doesn't belong in this file...causes trouble for BruceFactory.cpp */
30  }  }
31    
32  #include <iostream>  #ifndef PASO_MPI
33    #define MPI_Comm long
34    #endif
35    
36  #include <string>  #include <string>
 #include <memory>  
37  #include <algorithm>  #include <algorithm>
38    
39  #include <boost/shared_ptr.hpp>  #include <boost/shared_ptr.hpp>
40  #include <boost/python/object.hpp>  #include <boost/python/object.hpp>
 #include <boost/python/list.hpp>  
41  #include <boost/python/tuple.hpp>  #include <boost/python/tuple.hpp>
42  #include <boost/python/numeric.hpp>  #include <boost/python/numeric.hpp>
43    
44    namespace escript {
45    
46    //
47    // Forward declaration for various implementations of Data.
48    class DataConstant;
49    class DataTagged;
50    class DataExpanded;
51    
52  /**  /**
53     \brief     \brief
54     Data is essentially a factory class which creates the appropriate Data     Data creates the appropriate Data object for the given construction
55     object for the given construction arguments. It retains control over     arguments.
    the object created for the lifetime of the object.  
    The type of Data object referred to may change during the lifetime of  
    the Data object.  
56    
57     Description:     Description:
58     Data is essentially a factory class which creates the appropriate Data     Data is essentially a factory class which creates the appropriate Data
# Line 55  extern "C" { Line 61  extern "C" {
61     The type of Data object referred to may change during the lifetime of     The type of Data object referred to may change during the lifetime of
62     the Data object.     the Data object.
63  */  */
   
 namespace escript {  
   
 //  
 // Forward declaration for various implimentations of Data.  
 class DataEmpty;  
 class DataConstant;  
 class DataTagged;  
 class DataExpanded;  
   
64  class Data {  class Data {
65    
66    public:    public:
# Line 74  class Data { Line 70  class Data {
70    typedef double (*UnaryDFunPtr)(double);    typedef double (*UnaryDFunPtr)(double);
71    typedef double (*BinaryDFunPtr)(double,double);    typedef double (*BinaryDFunPtr)(double,double);
72    
73    
74    /**    /**
75       Constructors.       Constructors.
76    */    */
# Line 83  class Data { Line 80  class Data {
80       Default constructor.       Default constructor.
81       Creates a DataEmpty object.       Creates a DataEmpty object.
82    */    */
83      ESCRIPT_DLL_API
84    Data();    Data();
85    
86    /**    /**
# Line 90  class Data { Line 88  class Data {
88       Copy constructor.       Copy constructor.
89       WARNING: Only performs a shallow copy.       WARNING: Only performs a shallow copy.
90    */    */
91      ESCRIPT_DLL_API
92    Data(const Data& inData);    Data(const Data& inData);
93    
94    /**    /**
# Line 98  class Data { Line 97  class Data {
97       function space of inData the inData are tried to be interpolated to what,       function space of inData the inData are tried to be interpolated to what,
98       otherwise a shallow copy of inData is returned.       otherwise a shallow copy of inData is returned.
99    */    */
100      ESCRIPT_DLL_API
101    Data(const Data& inData,    Data(const Data& inData,
102         const FunctionSpace& what);         const FunctionSpace& what);
103    
# Line 111  class Data { Line 111  class Data {
111                         the value. Otherwise a more efficient storage                         the value. Otherwise a more efficient storage
112                         mechanism will be used.                         mechanism will be used.
113    */    */
114      ESCRIPT_DLL_API
115    Data(const DataArrayView& value,    Data(const DataArrayView& value,
116         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
117         bool expanded=false);         bool expanded=false);
# Line 126  class Data { Line 127  class Data {
127                         the given value. Otherwise a more efficient storage                         the given value. Otherwise a more efficient storage
128                         mechanism will be used.                         mechanism will be used.
129    */    */
130      ESCRIPT_DLL_API
131    Data(double value,    Data(double value,
132         const DataArrayView::ShapeType& dataPointShape=DataArrayView::ShapeType(),         const DataArrayView::ShapeType& dataPointShape=DataArrayView::ShapeType(),
133         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
# Line 138  class Data { Line 140  class Data {
140       \param inData - Input - Input Data object.       \param inData - Input - Input Data object.
141       \param region - Input - Region to copy.       \param region - Input - Region to copy.
142    */    */
143      ESCRIPT_DLL_API
144    Data(const Data& inData,    Data(const Data& inData,
145         const DataArrayView::RegionType& region);         const DataArrayView::RegionType& region);
146    
# Line 153  class Data { Line 156  class Data {
156       \param what - Input - A description of what this data represents.       \param what - Input - A description of what this data represents.
157       \param expanded - Input - Flag, if true fill the entire container with       \param expanded - Input - Flag, if true fill the entire container with
158                         the appropriate values.                         the appropriate values.
159        ==>*
160    */    */
161      ESCRIPT_DLL_API
162    Data(const DataTagged::TagListType& tagKeys,    Data(const DataTagged::TagListType& tagKeys,
163         const DataTagged::ValueListType& values,         const DataTagged::ValueListType& values,
164         const DataArrayView& defaultValue,         const DataArrayView& defaultValue,
# Line 170  class Data { Line 175  class Data {
175                         the value. Otherwise a more efficient storage                         the value. Otherwise a more efficient storage
176                         mechanism will be used.                         mechanism will be used.
177    */    */
178      ESCRIPT_DLL_API
179    Data(const boost::python::numeric::array& value,    Data(const boost::python::numeric::array& value,
180         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
181         bool expanded=false);         bool expanded=false);
# Line 185  class Data { Line 191  class Data {
191                         the value. Otherwise a more efficient storage                         the value. Otherwise a more efficient storage
192                         mechanism will be used.                         mechanism will be used.
193    */    */
194      ESCRIPT_DLL_API
195    Data(const boost::python::object& value,    Data(const boost::python::object& value,
196         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
197         bool expanded=false);         bool expanded=false);
# Line 198  class Data { Line 205  class Data {
205       \param value - Input - Input data.       \param value - Input - Input data.
206       \param other - Input - contains all other parameters.       \param other - Input - contains all other parameters.
207    */    */
208      ESCRIPT_DLL_API
209    Data(const boost::python::object& value,    Data(const boost::python::object& value,
210         const Data& other);         const Data& other);
211    
# Line 205  class Data { Line 213  class Data {
213       \brief       \brief
214       Constructor which creates a DataConstant of "shape" with constant value.       Constructor which creates a DataConstant of "shape" with constant value.
215    */    */
216      ESCRIPT_DLL_API
217    Data(double value,    Data(double value,
218         const boost::python::tuple& shape=boost::python::make_tuple(),         const boost::python::tuple& shape=boost::python::make_tuple(),
219         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
220         bool expanded=false);         bool expanded=false);
221      /**
222         \brief
223         Destructor
224      */
225      ESCRIPT_DLL_API
226      ~Data();
227    
228    /**    /**
229       \brief       \brief
230       Perform a deep copy.       Perform a deep copy.
231    */    */
232      ESCRIPT_DLL_API
233    void    void
234    copy(const Data& other);    copy(const Data& other);
235    
# Line 223  class Data { Line 239  class Data {
239    
240    /**    /**
241       \brief       \brief
242       Return the values of all data-points in a single python numarray object.       switches on update protection
243    
244    */    */
245    boost::python::numeric::array    ESCRIPT_DLL_API
246      void
247      setProtection();
248    
249      /**
250         \brief
251         Returns trueif the data object is protected against update
252    
253      */
254      ESCRIPT_DLL_API
255      bool
256      isProtected() const;
257      /**
258         \brief
259         Return the values of all data-points as a single python numarray object.
260      */
261      ESCRIPT_DLL_API
262      const boost::python::numeric::array
263    convertToNumArray();    convertToNumArray();
264    
265    /**    /**
266       \brief       \brief
267         Fills the expanded Data object from values of a python numarray object.
268      */
269      ESCRIPT_DLL_API
270      void
271      fillFromNumArray(const boost::python::numeric::array);
272    
273      /**
274         \brief
275         Return the values of a data point on this process
276      */
277      ESCRIPT_DLL_API
278      const boost::python::numeric::array
279      getValueOfDataPoint(int dataPointNo);
280    
281      /**
282         \brief
283         sets the values of a data-point on this process
284      */
285      ESCRIPT_DLL_API
286      void
287      setValueOfDataPointToArray(int dataPointNo, const boost::python::numeric::array);
288    
289      /**
290         \brief
291         sets the values of a data-point on this process
292      */
293      ESCRIPT_DLL_API
294      void
295      setValueOfDataPoint(int dataPointNo, const double);
296    
297      /**
298         \brief
299         Return the value of the specified data-point across all processors
300      */
301      ESCRIPT_DLL_API
302      const boost::python::numeric::array
303      getValueOfGlobalDataPoint(int procNo, int dataPointNo);
304    
305      /**
306         \brief
307         Return the tag number associated with the given data-point.
308    
309         The data-point number here corresponds to the data-point number in the
310         numarray returned by convertToNumArray.
311      */
312      ESCRIPT_DLL_API
313      int
314      getTagNumber(int dpno);
315    
316      /**
317         \brief
318       Return the C wrapper for the Data object.       Return the C wrapper for the Data object.
319    */    */
320      ESCRIPT_DLL_API
321    escriptDataC    escriptDataC
322    getDataC();    getDataC();
323    
# Line 239  class Data { Line 325  class Data {
325       \brief       \brief
326       Return the C wrapper for the Data object - const version.       Return the C wrapper for the Data object - const version.
327    */    */
328      ESCRIPT_DLL_API
329    escriptDataC    escriptDataC
330    getDataC() const;    getDataC() const;
331    
# Line 246  class Data { Line 333  class Data {
333       \brief       \brief
334       Write the data as a string.       Write the data as a string.
335    */    */
336      ESCRIPT_DLL_API
337    inline    inline
338    std::string    std::string
339    toString() const    toString() const
# Line 259  class Data { Line 347  class Data {
347       the shape information for each data point although it also may be used       the shape information for each data point although it also may be used
348       to manipulate the point data.       to manipulate the point data.
349    */    */
350      ESCRIPT_DLL_API
351    inline    inline
352    const DataArrayView&    const DataArrayView&
353    getPointDataView() const    getPointDataView() const
# Line 270  class Data { Line 359  class Data {
359       \brief       \brief
360       Whatever the current Data type make this into a DataExpanded.       Whatever the current Data type make this into a DataExpanded.
361    */    */
362      ESCRIPT_DLL_API
363    void    void
364    expand();    expand();
365    
# Line 278  class Data { Line 368  class Data {
368       If possible convert this Data to DataTagged. This will only allow       If possible convert this Data to DataTagged. This will only allow
369       Constant data to be converted to tagged. An attempt to convert       Constant data to be converted to tagged. An attempt to convert
370       Expanded data to tagged will throw an exception.       Expanded data to tagged will throw an exception.
371        ==>*
372    */    */
373      ESCRIPT_DLL_API
374    void    void
375    tag();    tag();
376    
# Line 286  class Data { Line 378  class Data {
378       \brief       \brief
379       Return true if this Data is expanded.       Return true if this Data is expanded.
380    */    */
381      ESCRIPT_DLL_API
382    bool    bool
383    isExpanded() const;    isExpanded() const;
384    
# Line 293  class Data { Line 386  class Data {
386       \brief       \brief
387       Return true if this Data is tagged.       Return true if this Data is tagged.
388    */    */
389      ESCRIPT_DLL_API
390    bool    bool
391    isTagged() const;    isTagged() const;
392    
# Line 300  class Data { Line 394  class Data {
394       \brief       \brief
395       Return true if this Data is constant.       Return true if this Data is constant.
396    */    */
397      ESCRIPT_DLL_API
398    bool    bool
399    isConstant() const;    isConstant() const;
400    
# Line 307  class Data { Line 402  class Data {
402       \brief       \brief
403       Return true if this Data is empty.       Return true if this Data is empty.
404    */    */
405      ESCRIPT_DLL_API
406    bool    bool
407    isEmpty() const;    isEmpty() const;
408    
# Line 314  class Data { Line 410  class Data {
410       \brief       \brief
411       Return the function space.       Return the function space.
412    */    */
413      ESCRIPT_DLL_API
414    inline    inline
415    const FunctionSpace&    const FunctionSpace&
416    getFunctionSpace() const    getFunctionSpace() const
# Line 325  class Data { Line 422  class Data {
422       \brief       \brief
423       Return a copy of the function space.       Return a copy of the function space.
424    */    */
425      ESCRIPT_DLL_API
426    const FunctionSpace    const FunctionSpace
427    getCopyOfFunctionSpace() const;    getCopyOfFunctionSpace() const;
428    
# Line 332  class Data { Line 430  class Data {
430       \brief       \brief
431       Return the domain.       Return the domain.
432    */    */
433      ESCRIPT_DLL_API
434    inline    inline
435    const AbstractDomain&    const AbstractDomain&
436    getDomain() const    getDomain() const
# Line 343  class Data { Line 442  class Data {
442       \brief       \brief
443       Return a copy of the domain.       Return a copy of the domain.
444    */    */
445      ESCRIPT_DLL_API
446    const AbstractDomain    const AbstractDomain
447    getCopyOfDomain() const;    getCopyOfDomain() const;
448    
# Line 350  class Data { Line 450  class Data {
450       \brief       \brief
451       Return the rank of the point data.       Return the rank of the point data.
452    */    */
453      ESCRIPT_DLL_API
454    inline    inline
455    int    int
456    getDataPointRank() const    getDataPointRank() const
# Line 359  class Data { Line 460  class Data {
460    
461    /**    /**
462       \brief       \brief
463         Return the number of data points
464      */
465      ESCRIPT_DLL_API
466      inline
467      int
468      getNumDataPoints() const
469      {
470        return getNumSamples() * getNumDataPointsPerSample();
471      }
472      /**
473         \brief
474       Return the number of samples.       Return the number of samples.
475    */    */
476      ESCRIPT_DLL_API
477    inline    inline
478    int    int
479    getNumSamples() const    getNumSamples() const
# Line 372  class Data { Line 485  class Data {
485       \brief       \brief
486       Return the number of data points per sample.       Return the number of data points per sample.
487    */    */
488      ESCRIPT_DLL_API
489    inline    inline
490    int    int
491    getNumDataPointsPerSample() const    getNumDataPointsPerSample() const
492    {    {
493      return m_data->getNumDPPSample();      return m_data->getNumDPPSample();
494    }    }
495      /**
496         \brief
497         dumps the object into a netCDF file
498      */
499      ESCRIPT_DLL_API
500      inline
501      void
502      dump(const std::string fileName) const
503      {
504        return m_data->dump(fileName);
505      }
506    
507    /**    /**
508       \brief       \brief
# Line 385  class Data { Line 510  class Data {
510       preferred interface but is provided for use by C code.       preferred interface but is provided for use by C code.
511       \param sampleNo - Input - the given sample no.       \param sampleNo - Input - the given sample no.
512    */    */
513      ESCRIPT_DLL_API
514    inline    inline
515    DataAbstract::ValueType::value_type*    DataAbstract::ValueType::value_type*
516    getSampleData(DataAbstract::ValueType::size_type sampleNo)    getSampleData(DataAbstract::ValueType::size_type sampleNo)
# Line 398  class Data { Line 524  class Data {
524       access data that isn't tagged an exception will be thrown.       access data that isn't tagged an exception will be thrown.
525       \param tag - Input - the tag key.       \param tag - Input - the tag key.
526    */    */
527      ESCRIPT_DLL_API
528    inline    inline
529    DataAbstract::ValueType::value_type*    DataAbstract::ValueType::value_type*
530    getSampleDataByTag(int tag)    getSampleDataByTag(int tag)
# Line 407  class Data { Line 534  class Data {
534    
535    /**    /**
536       \brief       \brief
      Assign the given value to the data-points referenced by the given  
      reference number.  
   
      The value supplied is a python numarray object.  The data from this numarray  
      is unpacked into a DataArray, and this is used to set the corresponding  
      data-points in the underlying Data object.  
   
      If the underlying Data object cannot be accessed via reference numbers, an  
      exception will be thrown.  
   
      \param ref - Input - reference number.  
      \param value - Input - value to assign to data-points associated with  
                             the given reference number.  
   */  
   void  
   setRefValue(int ref,  
               const boost::python::numeric::array& value);  
   
   /**  
      \brief  
      Return the values associated with the data-points referenced by the given  
      reference number.  
   
      The value supplied is a python numarray object. The data from the corresponding  
      data-points in this Data object are packed into the given numarray object.  
   
      If the underlying Data object cannot be accessed via reference numbers, an  
      exception will be thrown.  
   
      \param ref - Input - reference number.  
      \param value - Output - object to receive values from data-points  
                              associated with the given reference number.  
   */  
   void  
   getRefValue(int ref,  
               boost::python::numeric::array& value);  
   
   /**  
      \brief  
537       Return a view into the data for the data point specified.       Return a view into the data for the data point specified.
538       NOTE: Construction of the DataArrayView is a relatively expensive       NOTE: Construction of the DataArrayView is a relatively expensive
539       operation.       operation.
540       \param sampleNo - Input -       \param sampleNo - Input -
541       \param dataPointNo - Input -       \param dataPointNo - Input -
542    */    */
543      ESCRIPT_DLL_API
544    inline    inline
545    DataArrayView    DataArrayView
546    getDataPoint(int sampleNo,    getDataPoint(int sampleNo,
547                 int dataPointNo)                 int dataPointNo)
548    {    {
549      return m_data->getDataPoint(sampleNo,dataPointNo);          return m_data->getDataPoint(sampleNo,dataPointNo);
550    }    }
551    
552    /**    /**
553       \brief       \brief
554       Return a reference to the data point shape.       Return a reference to the data point shape.
555    */    */
556      ESCRIPT_DLL_API
557    const DataArrayView::ShapeType&    const DataArrayView::ShapeType&
558    getDataPointShape() const;    getDataPointShape() const;
559    
# Line 471  class Data { Line 561  class Data {
561       \brief       \brief
562       Return the data point shape as a tuple of integers.       Return the data point shape as a tuple of integers.
563    */    */
564    boost::python::tuple    ESCRIPT_DLL_API
565      const boost::python::tuple
566    getShapeTuple() const;    getShapeTuple() const;
567    
568    /**    /**
# Line 479  class Data { Line 570  class Data {
570       Return the size of the data point. It is the product of the       Return the size of the data point. It is the product of the
571       data point shape dimensions.       data point shape dimensions.
572    */    */
573      ESCRIPT_DLL_API
574    int    int
575    getDataPointSize() const;    getDataPointSize() const;
576    
# Line 486  class Data { Line 578  class Data {
578       \brief       \brief
579       Return the number of doubles stored for this Data.       Return the number of doubles stored for this Data.
580    */    */
581      ESCRIPT_DLL_API
582    DataArrayView::ValueType::size_type    DataArrayView::ValueType::size_type
583    getLength() const;    getLength() const;
584    
# Line 496  class Data { Line 589  class Data {
589       cannot be converted to a DataTagged object.       cannot be converted to a DataTagged object.
590       \param tagKey - Input - Integer key.       \param tagKey - Input - Integer key.
591       \param value - Input - Value to associate with given key.       \param value - Input - Value to associate with given key.
592        ==>*
593    */    */
594      ESCRIPT_DLL_API
595    void    void
596    setTaggedValue(int tagKey,    setTaggedValue(int tagKey,
597                   const boost::python::object& value);                   const boost::python::object& value);
# Line 508  class Data { Line 603  class Data {
603       cannot be converted to a DataTagged object.       cannot be converted to a DataTagged object.
604       \param tagKey - Input - Integer key.       \param tagKey - Input - Integer key.
605       \param value - Input - Value to associate with given key.       \param value - Input - Value to associate with given key.
606       Note: removed for now - this version not needed, and breaks escript.cpp      ==>*
607    */    */
608    /*    ESCRIPT_DLL_API
609    void    void
610    setTaggedValue(int tagKey,    setTaggedValueFromCPP(int tagKey,
611                   const DataArrayView& value);                          const DataArrayView& value);
   */  
612    
613    /**    /**
614      \brief      \brief
615      Copy other Data object into this Data object where mask is positive.      Copy other Data object into this Data object where mask is positive.
616    */    */
617      ESCRIPT_DLL_API
618    void    void
619    copyWithMask(const Data& other,    copyWithMask(const Data& other,
620                 const Data& mask);                 const Data& mask);
# Line 532  class Data { Line 627  class Data {
627       \brief       \brief
628       Interpolates this onto the given functionspace and returns       Interpolates this onto the given functionspace and returns
629       the result as a Data object.       the result as a Data object.
630         *
631    */    */
632      ESCRIPT_DLL_API
633    Data    Data
634    interpolate(const FunctionSpace& functionspace) const;    interpolate(const FunctionSpace& functionspace) const;
635    
# Line 540  class Data { Line 637  class Data {
637       \brief       \brief
638       Calculates the gradient of the data at the data points of functionspace.       Calculates the gradient of the data at the data points of functionspace.
639       If functionspace is not present the function space of Function(getDomain()) is used.       If functionspace is not present the function space of Function(getDomain()) is used.
640         *
641    */    */
642      ESCRIPT_DLL_API
643    Data    Data
644    gradOn(const FunctionSpace& functionspace) const;    gradOn(const FunctionSpace& functionspace) const;
645    
646      ESCRIPT_DLL_API
647    Data    Data
648    grad() const;    grad() const;
649    
650    /**    /**
651       \brief       \brief
652       Calculate the integral over the function space domain.       Calculate the integral over the function space domain.
653         *
654    */    */
655      ESCRIPT_DLL_API
656    boost::python::numeric::array    boost::python::numeric::array
657    integrate() const;    integrate() const;
658    
659    /**    /**
660       \brief       \brief
661         Returns 1./ Data object
662         *
663      */
664      ESCRIPT_DLL_API
665      Data
666      oneOver() const;
667      /**
668         \brief
669       Return a Data with a 1 for +ive values and a 0 for 0 or -ive values.       Return a Data with a 1 for +ive values and a 0 for 0 or -ive values.
670         *
671    */    */
672      ESCRIPT_DLL_API
673    Data    Data
674    wherePositive() const;    wherePositive() const;
675    
676    /**    /**
677       \brief       \brief
678       Return a Data with a 1 for -ive values and a 0 for +ive or 0 values.       Return a Data with a 1 for -ive values and a 0 for +ive or 0 values.
679         *
680    */    */
681      ESCRIPT_DLL_API
682    Data    Data
683    whereNegative() const;    whereNegative() const;
684    
685    /**    /**
686       \brief       \brief
687       Return a Data with a 1 for +ive or 0 values and a 0 for -ive values.       Return a Data with a 1 for +ive or 0 values and a 0 for -ive values.
688         *
689    */    */
690      ESCRIPT_DLL_API
691    Data    Data
692    whereNonNegative() const;    whereNonNegative() const;
693    
694    /**    /**
695       \brief       \brief
696       Return a Data with a 1 for -ive or 0 values and a 0 for +ive values.       Return a Data with a 1 for -ive or 0 values and a 0 for +ive values.
697         *
698    */    */
699      ESCRIPT_DLL_API
700    Data    Data
701    whereNonPositive() const;    whereNonPositive() const;
702    
703    /**    /**
704       \brief       \brief
705       Return a Data with a 1 for 0 values and a 0 for +ive or -ive values.       Return a Data with a 1 for 0 values and a 0 for +ive or -ive values.
706         *
707    */    */
708      ESCRIPT_DLL_API
709    Data    Data
710    whereZero() const;    whereZero(double tol=0.0) const;
711    
712    /**    /**
713       \brief       \brief
714       Return a Data with a 0 for 0 values and a 1 for +ive or -ive values.       Return a Data with a 0 for 0 values and a 1 for +ive or -ive values.
715         *
716    */    */
717      ESCRIPT_DLL_API
718    Data    Data
719    whereNonZero() const;    whereNonZero(double tol=0.0) const;
720    
721      /**
722         \brief
723         Return the maximum absolute value of this Data object.
724         *
725      */
726      ESCRIPT_DLL_API
727      double
728      Lsup() const;
729    
730      /**
731         \brief
732         Return the minimum absolute value of this Data object.
733         *
734      */
735      ESCRIPT_DLL_API
736      double
737      Linf() const;
738    
739      /**
740         \brief
741         Return the maximum value of this Data object.
742         *
743      */
744      ESCRIPT_DLL_API
745      double
746      sup() const;
747    
748      /**
749         \brief
750         Return the minimum value of this Data object.
751         *
752      */
753      ESCRIPT_DLL_API
754      double
755      inf() const;
756    
757      /**
758         \brief
759         Return the absolute value of each data point of this Data object.
760         *
761      */
762      ESCRIPT_DLL_API
763      Data
764      abs() const;
765    
766      /**
767         \brief
768         Return the maximum value of each data point of this Data object.
769         *
770      */
771      ESCRIPT_DLL_API
772      Data
773      maxval() const;
774    
775      /**
776         \brief
777         Return the minimum value of each data point of this Data object.
778         *
779      */
780      ESCRIPT_DLL_API
781      Data
782      minval() const;
783    
784      /**
785         \brief
786         Return the (sample number, data-point number) of the data point with
787         the minimum value in this Data object.
788      */
789      ESCRIPT_DLL_API
790      const boost::python::tuple
791      minGlobalDataPoint() const;
792    
793      ESCRIPT_DLL_API
794      void
795      calc_minGlobalDataPoint(int& ProcNo,  int& DataPointNo) const;
796      /**
797         \brief
798         Return the sign of each data point of this Data object.
799         -1 for negative values, zero for zero values, 1 for positive values.
800         *
801      */
802      ESCRIPT_DLL_API
803      Data
804      sign() const;
805    
806      /**
807         \brief
808         Return the symmetric part of a matrix which is half the matrix plus its transpose.
809         *
810      */
811      ESCRIPT_DLL_API
812      Data
813      symmetric() const;
814    
815      /**
816         \brief
817         Return the nonsymmetric part of a matrix which is half the matrix minus its transpose.
818         *
819      */
820      ESCRIPT_DLL_API
821      Data
822      nonsymmetric() const;
823    
824      /**
825         \brief
826         Return the trace of a matrix
827         *
828      */
829      ESCRIPT_DLL_API
830      Data
831      trace(int axis_offset) const;
832    
833      /**
834         \brief
835         Transpose each data point of this Data object around the given axis.
836         *
837      */
838      ESCRIPT_DLL_API
839      Data
840      transpose(int axis_offset) const;
841    
842      /**
843         \brief
844         Return the eigenvalues of the symmetric part at each data point of this Data object in increasing values.
845         Currently this function is restricted to rank 2, square shape, and dimension 3.
846         *
847      */
848      ESCRIPT_DLL_API
849      Data
850      eigenvalues() const;
851    
852      /**
853         \brief
854         Return the eigenvalues and corresponding eigenvcetors of the symmetric part at each data point of this Data object.
855         the eigenvalues are ordered in increasing size where eigenvalues with relative difference less than
856         tol are treated as equal. The eigenvectors are orthogonal, normalized and the sclaed such that the
857         first non-zero entry is positive.
858         Currently this function is restricted to rank 2, square shape, and dimension 3
859         *
860      */
861      ESCRIPT_DLL_API
862      const boost::python::tuple
863      eigenvalues_and_eigenvectors(const double tol=1.e-12) const;
864    
865      /**
866         \brief
867         swaps the components axis0 and axis1
868         *
869      */
870      ESCRIPT_DLL_API
871      Data
872      swapaxes(const int axis0, const int axis1) const;
873    
874      /**
875         \brief
876         Return the error function erf of each data point of this Data object.
877         *
878      */
879      ESCRIPT_DLL_API
880      Data
881      erf() const;
882    
883    /**    /**
884       \brief       \brief
885       Return the sin of each data point of this Data object.       Return the sin of each data point of this Data object.
886         *
887    */    */
888      ESCRIPT_DLL_API
889    Data    Data
890    sin() const;    sin() const;
891    
892    /**    /**
893       \brief       \brief
894       Return the cos of each data point of this Data object.       Return the cos of each data point of this Data object.
895         *
896    */    */
897      ESCRIPT_DLL_API
898    Data    Data
899    cos() const;    cos() const;
900    
901    /**    /**
902       \brief       \brief
903       Return the tan of each data point of this Data object.       Return the tan of each data point of this Data object.
904         *
905    */    */
906      ESCRIPT_DLL_API
907    Data    Data
908    tan() const;    tan() const;
909    
910    /**    /**
911       \brief       \brief
912       Return the log to base 10 of each data point of this Data object.       Return the asin of each data point of this Data object.
913         *
914    */    */
915      ESCRIPT_DLL_API
916    Data    Data
917    log() const;    asin() const;
918    
919    /**    /**
920       \brief       \brief
921       Return the natural log of each data point of this Data object.       Return the acos of each data point of this Data object.
922         *
923    */    */
924      ESCRIPT_DLL_API
925    Data    Data
926    ln() const;    acos() const;
927    
928    /**    /**
929       \brief       \brief
930       Return the maximum absolute value of this Data object.       Return the atan of each data point of this Data object.
931         *
932    */    */
933    double    ESCRIPT_DLL_API
934    Lsup() const;    Data
935      atan() const;
936    
937    /**    /**
938       \brief       \brief
939       Return the minimum absolute value of this Data object.       Return the sinh of each data point of this Data object.
940         *
941    */    */
942    double    ESCRIPT_DLL_API
943    Linf() const;    Data
944      sinh() const;
945    
946    /**    /**
947       \brief       \brief
948       Return the maximum value of this Data object.       Return the cosh of each data point of this Data object.
949         *
950    */    */
951    double    ESCRIPT_DLL_API
952    sup() const;    Data
953      cosh() const;
954    
955    /**    /**
956       \brief       \brief
957       Return the minimum value of this Data object.       Return the tanh of each data point of this Data object.
958         *
959    */    */
960    double    ESCRIPT_DLL_API
961    inf() const;    Data
962      tanh() const;
963    
964    /**    /**
965       \brief       \brief
966       Return the absolute value of each data point of this Data object.       Return the asinh of each data point of this Data object.
967         *
968    */    */
969      ESCRIPT_DLL_API
970    Data    Data
971    abs() const;    asinh() const;
972    
973    /**    /**
974       \brief       \brief
975       Return the maximum value of each data point of this Data object.       Return the acosh of each data point of this Data object.
976         *
977    */    */
978      ESCRIPT_DLL_API
979    Data    Data
980    maxval() const;    acosh() const;
981    
982    /**    /**
983       \brief       \brief
984       Return the minimum value of each data point of this Data object.       Return the atanh of each data point of this Data object.
985         *
986    */    */
987      ESCRIPT_DLL_API
988    Data    Data
989    minval() const;    atanh() const;
990    
991    /**    /**
992       \brief       \brief
993       Return the length of each data point of this Data object.       Return the log to base 10 of each data point of this Data object.
994       sqrt(sum(A[i,j,k,l]^2))       *
995    */    */
996      ESCRIPT_DLL_API
997    Data    Data
998    length() const;    log10() const;
999    
1000    /**    /**
1001       \brief       \brief
1002       Return the sign of each data point of this Data object.       Return the natural log of each data point of this Data object.
1003       -1 for negative values, zero for zero values, 1 for positive values.       *
1004    */    */
1005      ESCRIPT_DLL_API
1006    Data    Data
1007    sign() const;    log() const;
1008    
1009    /**    /**
1010      \transpose       \brief
1011      Transpose each data point of this Data object around the given axis.       Return the exponential function of each data point of this Data object.
1012      --* not implemented yet *--       *
1013    */    */
1014      ESCRIPT_DLL_API
1015    Data    Data
1016    transpose(int axis) const;    exp() const;
1017    
1018    /**    /**
1019      \trace       \brief
1020      Calculate the trace of each data point of this Data object.       Return the square root of each data point of this Data object.
1021      sum(A[i,i,i,i])       *
1022    */    */
1023      ESCRIPT_DLL_API
1024    Data    Data
1025    trace() const;    sqrt() const;
1026    
1027    /**    /**
1028      \exp       \brief
1029      Return the exponential function of each data point of this Data object.       Return the negation of each data point of this Data object.
1030         *
1031    */    */
1032      ESCRIPT_DLL_API
1033    Data    Data
1034    exp() const;    neg() const;
1035    
1036    /**    /**
1037      \sqrt       \brief
1038      Return the square root of each data point of this Data object.       Return the identity of each data point of this Data object.
1039         Simply returns this object unmodified.
1040         *
1041    */    */
1042      ESCRIPT_DLL_API
1043    Data    Data
1044    sqrt() const;    pos() const;
1045    
1046    /**    /**
1047       \brief       \brief
1048       Return the given power of each data point of this Data object.       Return the given power of each data point of this Data object.
1049    
1050         \param right Input - the power to raise the object to.
1051         *
1052    */    */
1053      ESCRIPT_DLL_API
1054    Data    Data
1055    powD(const Data& right) const;    powD(const Data& right) const;
1056    
1057      /**
1058         \brief
1059         Return the given power of each data point of this boost python object.
1060        
1061         \param right Input - the power to raise the object to.
1062         *
1063       */
1064      ESCRIPT_DLL_API
1065    Data    Data
1066    powO(const boost::python::object& right) const;    powO(const boost::python::object& right) const;
1067    
1068    /**    /**
1069      \brief       \brief
1070      writes the object to a file in the DX file format       Return the given power of each data point of this boost python object.
1071        
1072         \param left Input - the bases
1073         *
1074       */
1075    
1076      ESCRIPT_DLL_API
1077      Data
1078      rpowO(const boost::python::object& left) const;
1079    
1080      /**
1081         \brief
1082         writes the object to a file in the DX file format
1083    */    */
1084      ESCRIPT_DLL_API
1085    void    void
1086    saveDX(std::string fileName) const;    saveDX(std::string fileName) const;
1087    
1088    /**    /**
1089      \brief       \brief
1090      writes the object to a file in the VTK file format       writes the object to a file in the VTK file format
1091    */    */
1092      ESCRIPT_DLL_API
1093    void    void
1094    saveVTK(std::string fileName) const;    saveVTK(std::string fileName) const;
1095    
1096    /**    /**
     \brief  
     Return the negation of each data point of this Data object.  
   */  
   Data  
   neg() const;  
   
   /**  
     \brief  
     Return the identity of each data point of this Data object.  
     Simply returns this object unmodified.  
   */  
   Data  
   pos() const;  
   
   /**  
1097       \brief       \brief
1098       Overloaded operator +=       Overloaded operator +=
1099       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1100         *
1101    */    */
1102      ESCRIPT_DLL_API
1103    Data& operator+=(const Data& right);    Data& operator+=(const Data& right);
1104      ESCRIPT_DLL_API
1105    Data& operator+=(const boost::python::object& right);    Data& operator+=(const boost::python::object& right);
1106    
1107    /**    /**
1108       \brief       \brief
1109       Overloaded operator -=       Overloaded operator -=
1110       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1111         *
1112    */    */
1113      ESCRIPT_DLL_API
1114    Data& operator-=(const Data& right);    Data& operator-=(const Data& right);
1115      ESCRIPT_DLL_API
1116    Data& operator-=(const boost::python::object& right);    Data& operator-=(const boost::python::object& right);
1117    
1118   /**   /**
1119       \brief       \brief
1120       Overloaded operator *=       Overloaded operator *=
1121       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1122         *
1123    */    */
1124      ESCRIPT_DLL_API
1125    Data& operator*=(const Data& right);    Data& operator*=(const Data& right);
1126      ESCRIPT_DLL_API
1127    Data& operator*=(const boost::python::object& right);    Data& operator*=(const boost::python::object& right);
1128    
1129   /**   /**
1130       \brief       \brief
1131       Overloaded operator /=       Overloaded operator /=
1132       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1133         *
1134    */    */
1135      ESCRIPT_DLL_API
1136    Data& operator/=(const Data& right);    Data& operator/=(const Data& right);
1137      ESCRIPT_DLL_API
1138    Data& operator/=(const boost::python::object& right);    Data& operator/=(const boost::python::object& right);
1139    
1140    /**    /**
1141       \brief       \brief
1142       Returns true if this can be interpolated to functionspace.       Returns true if this can be interpolated to functionspace.
1143    */    */
1144      ESCRIPT_DLL_API
1145    bool    bool
1146    probeInterpolation(const FunctionSpace& functionspace) const;    probeInterpolation(const FunctionSpace& functionspace) const;
1147    
# Line 819  class Data { Line 1160  class Data {
1160       \param key - Input - python slice tuple specifying       \param key - Input - python slice tuple specifying
1161       slice to return.       slice to return.
1162    */    */
1163      ESCRIPT_DLL_API
1164    Data    Data
1165    getItem(const boost::python::object& key) const;    getItem(const boost::python::object& key) const;
1166    
# Line 826  class Data { Line 1168  class Data {
1168       \brief       \brief
1169       Copies slice from value into this Data object.       Copies slice from value into this Data object.
1170    
      \description  
1171       Implements the [] set operator in python.       Implements the [] set operator in python.
1172       Calls setSlice.       Calls setSlice.
1173    
# Line 834  class Data { Line 1175  class Data {
1175       slice to copy from value.       slice to copy from value.
1176       \param value - Input - Data object to copy from.       \param value - Input - Data object to copy from.
1177    */    */
1178      ESCRIPT_DLL_API
1179    void    void
1180    setItemD(const boost::python::object& key,    setItemD(const boost::python::object& key,
1181             const Data& value);             const Data& value);
1182    
1183      ESCRIPT_DLL_API
1184    void    void
1185    setItemO(const boost::python::object& key,    setItemO(const boost::python::object& key,
1186             const boost::python::object& value);             const boost::python::object& value);
# Line 850  class Data { Line 1193  class Data {
1193       this Data object.       this Data object.
1194    */    */
1195    template <class UnaryFunction>    template <class UnaryFunction>
1196      ESCRIPT_DLL_API
1197    inline    inline
1198    void    void
1199    unaryOp(UnaryFunction operation);    unaryOp(UnaryFunction operation);
# Line 859  class Data { Line 1203  class Data {
1203       Return a Data object containing the specified slice of       Return a Data object containing the specified slice of
1204       this Data object.       this Data object.
1205       \param region - Input - Region to copy.       \param region - Input - Region to copy.
1206         *
1207    */    */
1208      ESCRIPT_DLL_API
1209    Data    Data
1210    getSlice(const DataArrayView::RegionType& region) const;    getSlice(const DataArrayView::RegionType& region) const;
1211    
# Line 869  class Data { Line 1215  class Data {
1215       Data object.       Data object.
1216       \param value - Input - Data to copy from.       \param value - Input - Data to copy from.
1217       \param region - Input - Region to copy.       \param region - Input - Region to copy.
1218         *
1219    */    */
1220      ESCRIPT_DLL_API
1221    void    void
1222    setSlice(const Data& value,    setSlice(const Data& value,
1223             const DataArrayView::RegionType& region);             const DataArrayView::RegionType& region);
# Line 879  class Data { Line 1227  class Data {
1227       Archive the current Data object to the given file.       Archive the current Data object to the given file.
1228       \param fileName - Input - file to archive to.       \param fileName - Input - file to archive to.
1229    */    */
1230      ESCRIPT_DLL_API
1231    void    void
1232    archiveData(const std::string fileName);    archiveData(const std::string fileName);
1233    
# Line 888  class Data { Line 1237  class Data {
1237       the current Data object.       the current Data object.
1238       Note - the current object must be of type DataEmpty.       Note - the current object must be of type DataEmpty.
1239       \param fileName - Input - file to extract from.       \param fileName - Input - file to extract from.
1240       \param what - Input - a suitable FunctionSpace descibing the data.       \param fspace - Input - a suitable FunctionSpace descibing the data.
1241    */    */
1242      ESCRIPT_DLL_API
1243    void    void
1244    extractData(const std::string fileName,    extractData(const std::string fileName,
1245                const FunctionSpace& fspace);                const FunctionSpace& fspace);
1246    
1247    
1248      /**
1249         \brief
1250         print the data values to stdout. Used for debugging
1251      */
1252      ESCRIPT_DLL_API
1253      void
1254        print(void);
1255    
1256      /**
1257         \brief
1258         return the MPI rank number of the local data
1259             MPI_COMM_WORLD is assumed and the result of MPI_Comm_size()
1260             is returned
1261      */
1262      ESCRIPT_DLL_API
1263        int
1264        get_MPIRank(void) const;
1265    
1266      /**
1267         \brief
1268         return the MPI rank number of the local data
1269             MPI_COMM_WORLD is assumed and the result of MPI_Comm_rank()
1270             is returned
1271      */
1272      ESCRIPT_DLL_API
1273        int
1274        get_MPISize(void) const;
1275    
1276      /**
1277         \brief
1278         return the MPI rank number of the local data
1279             MPI_COMM_WORLD is assumed and returned.
1280      */
1281      ESCRIPT_DLL_API
1282        MPI_Comm
1283        get_MPIComm(void) const;
1284    
1285      /**
1286         \brief
1287         return the object produced by the factory, which is a DataConstant or DataExpanded
1288      */
1289      ESCRIPT_DLL_API
1290        DataAbstract*
1291        borrowData(void) const;
1292    
1293   protected:   protected:
1294    
1295   private:   private:
# Line 916  class Data { Line 1312  class Data {
1312       Perform the specified reduction algorithm on every element of every data point in       Perform the specified reduction algorithm on every element of every data point in
1313       this Data object according to the given function and return the single value result.       this Data object according to the given function and return the single value result.
1314    */    */
1315    template <class UnaryFunction>    template <class BinaryFunction>
1316    inline    inline
1317    double    double
1318    algorithm(UnaryFunction operation) const;    algorithm(BinaryFunction operation,
1319                double initial_value) const;
1320    
1321    /**    /**
1322       \brief       \brief
# Line 928  class Data { Line 1325  class Data {
1325       one value - the result of the reduction operation on the corresponding data-point in       one value - the result of the reduction operation on the corresponding data-point in
1326       this Data object       this Data object
1327    */    */
1328    template <class UnaryFunction>    template <class BinaryFunction>
1329    inline    inline
1330    Data    Data
1331    dp_algorithm(UnaryFunction operation) const;    dp_algorithm(BinaryFunction operation,
1332                   double initial_value) const;
1333    
1334    /**    /**
1335       \brief       \brief
# Line 949  class Data { Line 1347  class Data {
1347    
1348    /**    /**
1349       \brief       \brief
      Perform the given binary operation on all of the data's elements.  
      RHS is a boost::python object.  
   */  
   template <class BinaryFunction>  
   inline  
   void  
   binaryOp(const boost::python::object& right,  
            BinaryFunction operation);  
   
   /**  
      \brief  
1350       Convert the data type of the RHS to match this.       Convert the data type of the RHS to match this.
1351       \param right - Input - data type to match.       \param right - Input - data type to match.
1352    */    */
# Line 984  class Data { Line 1371  class Data {
1371               const FunctionSpace& what,               const FunctionSpace& what,
1372               bool expanded);               bool expanded);
1373    
1374    /**    //
1375       \brief    // flag to protect the data object against any update
1376       Reshape the data point if the data point is currently rank 0.    bool m_protected;
      Will throw an exception if the data points are not rank 0.  
      The original data point value is used for all values of the new  
      data point.  
   */  
   void  
   reshapeDataPoint(const DataArrayView::ShapeType& shape);  
1377    
1378    //    //
1379    // pointer to the actual data object    // pointer to the actual data object
1380    boost::shared_ptr<DataAbstract> m_data;    boost::shared_ptr<DataAbstract> m_data;
1381    
1382      //
1383      // pointer to the internal profiling data
1384      struct profDataEntry *profData;
1385    
1386  };  };
1387    
1388  template <class IValueType>  template <class IValueType>
# Line 1025  Data::initialise(const IValueType& value Line 1410  Data::initialise(const IValueType& value
1410  /**  /**
1411     Binary Data object operators.     Binary Data object operators.
1412  */  */
1413    inline double rpow(double x,double y)
1414    {
1415        return pow(y,x);
1416    };
1417    
1418  /**  /**
1419    \brief    \brief
1420    Operator+    Operator+
1421    Takes two Data objects.    Takes two Data objects.
1422  */  */
1423  Data operator+(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator+(const Data& left, const Data& right);
1424    
1425  /**  /**
1426    \brief    \brief
1427    Operator-    Operator-
1428    Takes two Data objects.    Takes two Data objects.
1429  */  */
1430  Data operator-(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator-(const Data& left, const Data& right);
1431    
1432  /**  /**
1433    \brief    \brief
1434    Operator*    Operator*
1435    Takes two Data objects.    Takes two Data objects.
1436  */  */
1437  Data operator*(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator*(const Data& left, const Data& right);
1438    
1439  /**  /**
1440    \brief    \brief
1441    Operator/    Operator/
1442    Takes two Data objects.    Takes two Data objects.
1443  */  */
1444  Data operator/(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator/(const Data& left, const Data& right);
1445    
1446  /**  /**
1447    \brief    \brief
# Line 1060  Data operator/(const Data& left, const D Line 1449  Data operator/(const Data& left, const D
1449    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1450    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1451  */  */
1452  Data operator+(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator+(const Data& left, const boost::python::object& right);
1453    
1454  /**  /**
1455    \brief    \brief
# Line 1068  Data operator+(const Data& left, const b Line 1457  Data operator+(const Data& left, const b
1457    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1458    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1459  */  */
1460  Data operator-(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator-(const Data& left, const boost::python::object& right);
1461    
1462  /**  /**
1463    \brief    \brief
# Line 1076  Data operator-(const Data& left, const b Line 1465  Data operator-(const Data& left, const b
1465    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1466    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1467  */  */
1468  Data operator*(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator*(const Data& left, const boost::python::object& right);
1469    
1470  /**  /**
1471    \brief    \brief
# Line 1084  Data operator*(const Data& left, const b Line 1473  Data operator*(const Data& left, const b
1473    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1474    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1475  */  */
1476  Data operator/(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator/(const Data& left, const boost::python::object& right);
1477    
1478  /**  /**
1479    \brief    \brief
# Line 1092  Data operator/(const Data& left, const b Line 1481  Data operator/(const Data& left, const b
1481    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1482    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1483  */  */
1484  Data operator+(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator+(const boost::python::object& left, const Data& right);
1485    
1486  /**  /**
1487    \brief    \brief
# Line 1100  Data operator+(const boost::python::obje Line 1489  Data operator+(const boost::python::obje
1489    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1490    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1491  */  */
1492  Data operator-(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator-(const boost::python::object& left, const Data& right);
1493    
1494  /**  /**
1495    \brief    \brief
# Line 1108  Data operator-(const boost::python::obje Line 1497  Data operator-(const boost::python::obje
1497    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1498    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1499  */  */
1500  Data operator*(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator*(const boost::python::object& left, const Data& right);
1501    
1502  /**  /**
1503    \brief    \brief
# Line 1116  Data operator*(const boost::python::obje Line 1505  Data operator*(const boost::python::obje
1505    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1506    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1507  */  */
1508  Data operator/(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator/(const boost::python::object& left, const Data& right);
1509    
1510  /**  /**
1511    \brief    \brief
1512    Output operator    Output operator
1513  */  */
1514  std::ostream& operator<<(std::ostream& o, const Data& data);  ESCRIPT_DLL_API std::ostream& operator<<(std::ostream& o, const Data& data);
1515    
1516    /**
1517      \brief
1518      Compute a tensor product of two Data objects
1519      \param arg0 - Input - Data object
1520      \param arg1 - Input - Data object
1521      \param axis_offset - Input - axis offset
1522      \param transpose - Input - 0: transpose neither, 1: transpose arg0, 2: transpose arg1
1523    */
1524    ESCRIPT_DLL_API
1525    Data
1526    C_GeneralTensorProduct(Data& arg0,
1527                         Data& arg1,
1528                         int axis_offset=0,
1529                         int transpose=0);
1530    
1531  /**  /**
1532    \brief    \brief
# Line 1130  std::ostream& operator<<(std::ostream& o Line 1534  std::ostream& operator<<(std::ostream& o
1534    NB: this operator does very little at this point, and isn't to    NB: this operator does very little at this point, and isn't to
1535    be relied on. Requires further implementation.    be relied on. Requires further implementation.
1536  */  */
1537  //bool operator==(const Data& left, const Data& right);  //ESCRIPT_DLL_API bool operator==(const Data& left, const Data& right);
1538    
1539  /**  /**
1540    \brief    \brief
# Line 1146  Data::binaryOp(const Data& right, Line 1550  Data::binaryOp(const Data& right,
1550     //     //
1551     // if this has a rank of zero promote it to the rank of the RHS     // if this has a rank of zero promote it to the rank of the RHS
1552     if (getPointDataView().getRank()==0 && right.getPointDataView().getRank()!=0) {     if (getPointDataView().getRank()==0 && right.getPointDataView().getRank()!=0) {
1553       reshapeDataPoint(right.getPointDataView().getShape());       throw DataException("Error - attempt to update rank zero object with object with rank bigger than zero.");
1554     }     }
1555     //     //
1556     // initially make the temporary a shallow copy     // initially make the temporary a shallow copy
# Line 1198  Data::binaryOp(const Data& right, Line 1602  Data::binaryOp(const Data& right,
1602       EsysAssert((leftC!=0 && rightC!=0), "Programming error - casting to DataConstant.");       EsysAssert((leftC!=0 && rightC!=0), "Programming error - casting to DataConstant.");
1603       escript::binaryOp(*leftC,*rightC,operation);       escript::binaryOp(*leftC,*rightC,operation);
1604     }     }
1605  }     #if defined DOPROF
1606       profData->binary++;
1607  /**     #endif
   \brief  
   Perform the given binary operation with this and right as operands.  
   Right is a boost::python object.  
 */  
 template <class BinaryFunction>  
 inline  
 void  
 Data::binaryOp(const boost::python::object& right,  
                BinaryFunction operation)  
 {  
    DataArray temp(right);  
    //  
    // if this has a rank of zero promote it to the rank of the RHS.  
    if (getPointDataView().getRank()==0 && temp.getView().getRank()!=0) {  
       reshapeDataPoint(temp.getView().getShape());  
    }  
    //  
    // Always allow scalar values for the RHS but check other shapes  
    if (temp.getView().getRank()!=0) {  
      if (!getPointDataView().checkShape(temp.getView().getShape())) {  
        throw DataException(getPointDataView().createShapeErrorMessage(  
                   "Error - RHS shape doesn't match LHS shape.",temp.getView().getShape()));  
      }  
    }  
    if (isExpanded()) {  
      DataExpanded* leftC=dynamic_cast<DataExpanded*>(m_data.get());  
      EsysAssert((leftC!=0),"Programming error - casting to DataExpanded.");  
      escript::binaryOp(*leftC,temp.getView(),operation);  
    } else if (isTagged()) {  
      DataTagged* leftC=dynamic_cast<DataTagged*>(m_data.get());  
      EsysAssert((leftC!=0), "Programming error - casting to DataTagged.");  
      escript::binaryOp(*leftC,temp.getView(),operation);  
    } else if (isConstant()) {  
      DataConstant* leftC=dynamic_cast<DataConstant*>(m_data.get());  
      EsysAssert((leftC!=0),"Programming error - casting to DataConstant.");  
      escript::binaryOp(*leftC,temp.getView(),operation);  
    }  
1608  }  }
1609    
1610  /**  /**
# Line 1293  Data::unaryOp(UnaryFunction operation) Line 1660  Data::unaryOp(UnaryFunction operation)
1660    object (*this) is a rank n Data object, and returned object is a scalar.    object (*this) is a rank n Data object, and returned object is a scalar.
1661    Calls escript::algorithm.    Calls escript::algorithm.
1662  */  */
1663  template <class UnaryFunction>  template <class BinaryFunction>
1664  inline  inline
1665  double  double
1666  Data::algorithm(UnaryFunction operation) const  Data::algorithm(BinaryFunction operation, double initial_value) const
1667  {  {
1668    if (isExpanded()) {    if (isExpanded()) {
1669      DataExpanded* leftC=dynamic_cast<DataExpanded*>(m_data.get());      DataExpanded* leftC=dynamic_cast<DataExpanded*>(m_data.get());
1670      EsysAssert((leftC!=0), "Programming error - casting to DataExpanded.");      EsysAssert((leftC!=0), "Programming error - casting to DataExpanded.");
1671      return escript::algorithm(*leftC,operation);      return escript::algorithm(*leftC,operation,initial_value);
1672    } else if (isTagged()) {    } else if (isTagged()) {
1673      DataTagged* leftC=dynamic_cast<DataTagged*>(m_data.get());      DataTagged* leftC=dynamic_cast<DataTagged*>(m_data.get());
1674      EsysAssert((leftC!=0), "Programming error - casting to DataTagged.");      EsysAssert((leftC!=0), "Programming error - casting to DataTagged.");
1675      return escript::algorithm(*leftC,operation);      return escript::algorithm(*leftC,operation,initial_value);
1676    } else if (isConstant()) {    } else if (isConstant()) {
1677      DataConstant* leftC=dynamic_cast<DataConstant*>(m_data.get());      DataConstant* leftC=dynamic_cast<DataConstant*>(m_data.get());
1678      EsysAssert((leftC!=0), "Programming error - casting to DataConstant.");      EsysAssert((leftC!=0), "Programming error - casting to DataConstant.");
1679      return escript::algorithm(*leftC,operation);      return escript::algorithm(*leftC,operation,initial_value);
1680    }    }
1681    return 0;    return 0;
1682  }  }
# Line 1322  Data::algorithm(UnaryFunction operation) Line 1689  Data::algorithm(UnaryFunction operation)
1689    rank 0 Data object.    rank 0 Data object.
1690    Calls escript::dp_algorithm.    Calls escript::dp_algorithm.
1691  */  */
1692  template <class UnaryFunction>  template <class BinaryFunction>
1693  inline  inline
1694  Data  Data
1695  Data::dp_algorithm(UnaryFunction operation) const  Data::dp_algorithm(BinaryFunction operation, double initial_value) const
1696  {  {
   Data result(0,DataArrayView::ShapeType(),getFunctionSpace(),isExpanded());  
1697    if (isExpanded()) {    if (isExpanded()) {
1698        Data result(0,DataArrayView::ShapeType(),getFunctionSpace(),isExpanded());
1699      DataExpanded* dataE=dynamic_cast<DataExpanded*>(m_data.get());      DataExpanded* dataE=dynamic_cast<DataExpanded*>(m_data.get());
1700      DataExpanded* resultE=dynamic_cast<DataExpanded*>(result.m_data.get());      DataExpanded* resultE=dynamic_cast<DataExpanded*>(result.m_data.get());
1701      EsysAssert((dataE!=0), "Programming error - casting data to DataExpanded.");      EsysAssert((dataE!=0), "Programming error - casting data to DataExpanded.");
1702      EsysAssert((resultE!=0), "Programming error - casting result to DataExpanded.");      EsysAssert((resultE!=0), "Programming error - casting result to DataExpanded.");
1703      escript::dp_algorithm(*dataE,*resultE,operation);      escript::dp_algorithm(*dataE,*resultE,operation,initial_value);
1704        return result;
1705    } else if (isTagged()) {    } else if (isTagged()) {
1706      DataTagged* dataT=dynamic_cast<DataTagged*>(m_data.get());      DataTagged* dataT=dynamic_cast<DataTagged*>(m_data.get());
1707        DataArrayView::ShapeType viewShape;
1708        DataArrayView::ValueType viewData(1);
1709        viewData[0]=0;
1710        DataArrayView defaultValue(viewData,viewShape);
1711        DataTagged::TagListType keys;
1712        DataTagged::ValueListType values;
1713        DataTagged::DataMapType::const_iterator i;
1714        for (i=dataT->getTagLookup().begin();i!=dataT->getTagLookup().end();i++) {
1715          keys.push_back(i->first);
1716          values.push_back(defaultValue);
1717        }
1718        Data result(keys,values,defaultValue,getFunctionSpace());
1719      DataTagged* resultT=dynamic_cast<DataTagged*>(result.m_data.get());      DataTagged* resultT=dynamic_cast<DataTagged*>(result.m_data.get());
1720      EsysAssert((dataT!=0), "Programming error - casting data to DataTagged.");      EsysAssert((dataT!=0), "Programming error - casting data to DataTagged.");
1721      EsysAssert((resultT!=0), "Programming error - casting result to DataTagged.");      EsysAssert((resultT!=0), "Programming error - casting result to DataTagged.");
1722      escript::dp_algorithm(*dataT,*resultT,operation);      escript::dp_algorithm(*dataT,*resultT,operation,initial_value);
1723        return result;
1724    } else if (isConstant()) {    } else if (isConstant()) {
1725        Data result(0,DataArrayView::ShapeType(),getFunctionSpace(),isExpanded());
1726      DataConstant* dataC=dynamic_cast<DataConstant*>(m_data.get());      DataConstant* dataC=dynamic_cast<DataConstant*>(m_data.get());
1727      DataConstant* resultC=dynamic_cast<DataConstant*>(result.m_data.get());      DataConstant* resultC=dynamic_cast<DataConstant*>(result.m_data.get());
1728      EsysAssert((dataC!=0), "Programming error - casting data to DataConstant.");      EsysAssert((dataC!=0), "Programming error - casting data to DataConstant.");
1729      EsysAssert((resultC!=0), "Programming error - casting result to DataConstant.");      EsysAssert((resultC!=0), "Programming error - casting result to DataConstant.");
1730      escript::dp_algorithm(*dataC,*resultC,operation);      escript::dp_algorithm(*dataC,*resultC,operation,initial_value);
1731        return result;
1732    }    }
1733    return result;    Data falseRetVal; // to keep compiler quiet
1734      return falseRetVal;
1735  }  }
1736    
1737  }  }

Legend:
Removed from v.119  
changed lines
  Added in v.969

  ViewVC Help
Powered by ViewVC 1.1.26