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

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

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

trunk/esys2/escript/src/Data/Data.h revision 149 by jgs, Thu Sep 1 03:31:39 2005 UTC trunk/escript/src/Data.h revision 1312 by ksteube, Mon Sep 24 06:18:44 2007 UTC
# Line 1  Line 1 
1  // $Id$  
2  /*  /* $Id$ */
3   ******************************************************************************  
4   *                                                                            *  /*******************************************************
5   *       COPYRIGHT ACcESS 2004 -  All Rights Reserved                         *   *
6   *                                                                            *   *           Copyright 2003-2007 by ACceSS MNRF
7   * This software is the property of ACcESS.  No part of this code             *   *       Copyright 2007 by University of Queensland
8   * may be copied in any form or by any means without the expressed written    *   *
9   * consent of ACcESS.  Copying, use or modification of this software          *   *                http://esscc.uq.edu.au
10   * by any unauthorised person is illegal unless that                          *   *        Primary Business: Queensland, Australia
11   * person has a software license agreement with ACcESS.                       *   *  Licensed under the Open Software License version 3.0
12   *                                                                            *   *     http://www.opensource.org/licenses/osl-3.0.php
13   ******************************************************************************   *
14  */   *******************************************************/
15    
16  /** \file Data.h */  /** \file Data.h */
17    
18  #ifndef DATA_H  #ifndef DATA_H
19  #define DATA_H  #define DATA_H
20    #include "system_dep.h"
21    
22  #include "escript/Data/DataAbstract.h"  #include "DataAbstract.h"
23  #include "escript/Data/DataTagged.h"  #include "DataAlgorithm.h"
24  #include "escript/Data/DataAlgorithm.h"  #include "FunctionSpace.h"
25  #include "escript/Data/FunctionSpace.h"  #include "BinaryOp.h"
26  #include "escript/Data/BinaryOp.h"  #include "UnaryOp.h"
27  #include "escript/Data/UnaryOp.h"  #include "DataException.h"
 #include "escript/Data/DataException.h"  
28    
29  extern "C" {  extern "C" {
30  #include "escript/Data/DataC.h"  #include "DataC.h"
31    /* #include "paso/Paso.h" doesn't belong in this file...causes trouble for BruceFactory.cpp */
32  }  }
33    
34  #include <iostream>  #include "esysmpi.h"
35  #include <string>  #include <string>
 #include <memory>  
36  #include <algorithm>  #include <algorithm>
37    
38  #include <boost/shared_ptr.hpp>  #include <boost/shared_ptr.hpp>
39  #include <boost/python/object.hpp>  #include <boost/python/object.hpp>
 #include <boost/python/list.hpp>  
40  #include <boost/python/tuple.hpp>  #include <boost/python/tuple.hpp>
41  #include <boost/python/numeric.hpp>  #include <boost/python/numeric.hpp>
42    
# Line 45  namespace escript { Line 44  namespace escript {
44    
45  //  //
46  // Forward declaration for various implementations of Data.  // Forward declaration for various implementations of Data.
 class DataEmpty;  
47  class DataConstant;  class DataConstant;
48  class DataTagged;  class DataTagged;
49  class DataExpanded;  class DataExpanded;
# Line 71  class Data { Line 69  class Data {
69    typedef double (*UnaryDFunPtr)(double);    typedef double (*UnaryDFunPtr)(double);
70    typedef double (*BinaryDFunPtr)(double,double);    typedef double (*BinaryDFunPtr)(double,double);
71    
72    
73    /**    /**
74       Constructors.       Constructors.
75    */    */
# Line 80  class Data { Line 79  class Data {
79       Default constructor.       Default constructor.
80       Creates a DataEmpty object.       Creates a DataEmpty object.
81    */    */
82      ESCRIPT_DLL_API
83    Data();    Data();
84    
85    /**    /**
# Line 87  class Data { Line 87  class Data {
87       Copy constructor.       Copy constructor.
88       WARNING: Only performs a shallow copy.       WARNING: Only performs a shallow copy.
89    */    */
90      ESCRIPT_DLL_API
91    Data(const Data& inData);    Data(const Data& inData);
92    
93    /**    /**
# Line 95  class Data { Line 96  class Data {
96       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,
97       otherwise a shallow copy of inData is returned.       otherwise a shallow copy of inData is returned.
98    */    */
99      ESCRIPT_DLL_API
100    Data(const Data& inData,    Data(const Data& inData,
101         const FunctionSpace& what);         const FunctionSpace& what);
102    
# Line 108  class Data { Line 110  class Data {
110                         the value. Otherwise a more efficient storage                         the value. Otherwise a more efficient storage
111                         mechanism will be used.                         mechanism will be used.
112    */    */
113      ESCRIPT_DLL_API
114    Data(const DataArrayView& value,    Data(const DataArrayView& value,
115         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
116         bool expanded=false);         bool expanded=false);
# Line 123  class Data { Line 126  class Data {
126                         the given value. Otherwise a more efficient storage                         the given value. Otherwise a more efficient storage
127                         mechanism will be used.                         mechanism will be used.
128    */    */
129      ESCRIPT_DLL_API
130    Data(double value,    Data(double value,
131         const DataArrayView::ShapeType& dataPointShape=DataArrayView::ShapeType(),         const DataArrayView::ShapeType& dataPointShape=DataArrayView::ShapeType(),
132         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
# Line 135  class Data { Line 139  class Data {
139       \param inData - Input - Input Data object.       \param inData - Input - Input Data object.
140       \param region - Input - Region to copy.       \param region - Input - Region to copy.
141    */    */
142      ESCRIPT_DLL_API
143    Data(const Data& inData,    Data(const Data& inData,
144         const DataArrayView::RegionType& region);         const DataArrayView::RegionType& region);
145    
# Line 150  class Data { Line 155  class Data {
155       \param what - Input - A description of what this data represents.       \param what - Input - A description of what this data represents.
156       \param expanded - Input - Flag, if true fill the entire container with       \param expanded - Input - Flag, if true fill the entire container with
157                         the appropriate values.                         the appropriate values.
158        ==>*
159    */    */
160      ESCRIPT_DLL_API
161    Data(const DataTagged::TagListType& tagKeys,    Data(const DataTagged::TagListType& tagKeys,
162         const DataTagged::ValueListType& values,         const DataTagged::ValueListType& values,
163         const DataArrayView& defaultValue,         const DataArrayView& defaultValue,
# Line 167  class Data { Line 174  class Data {
174                         the value. Otherwise a more efficient storage                         the value. Otherwise a more efficient storage
175                         mechanism will be used.                         mechanism will be used.
176    */    */
177      ESCRIPT_DLL_API
178    Data(const boost::python::numeric::array& value,    Data(const boost::python::numeric::array& value,
179         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
180         bool expanded=false);         bool expanded=false);
# Line 182  class Data { Line 190  class Data {
190                         the value. Otherwise a more efficient storage                         the value. Otherwise a more efficient storage
191                         mechanism will be used.                         mechanism will be used.
192    */    */
193      ESCRIPT_DLL_API
194    Data(const boost::python::object& value,    Data(const boost::python::object& value,
195         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
196         bool expanded=false);         bool expanded=false);
# Line 195  class Data { Line 204  class Data {
204       \param value - Input - Input data.       \param value - Input - Input data.
205       \param other - Input - contains all other parameters.       \param other - Input - contains all other parameters.
206    */    */
207      ESCRIPT_DLL_API
208    Data(const boost::python::object& value,    Data(const boost::python::object& value,
209         const Data& other);         const Data& other);
210    
# Line 202  class Data { Line 212  class Data {
212       \brief       \brief
213       Constructor which creates a DataConstant of "shape" with constant value.       Constructor which creates a DataConstant of "shape" with constant value.
214    */    */
215      ESCRIPT_DLL_API
216    Data(double value,    Data(double value,
217         const boost::python::tuple& shape=boost::python::make_tuple(),         const boost::python::tuple& shape=boost::python::make_tuple(),
218         const FunctionSpace& what=FunctionSpace(),         const FunctionSpace& what=FunctionSpace(),
219         bool expanded=false);         bool expanded=false);
220      /**
221         \brief
222         Destructor
223      */
224      ESCRIPT_DLL_API
225      ~Data();
226    
227    /**    /**
228       \brief       \brief
229       Perform a deep copy.       Perform a deep copy.
230    */    */
231      ESCRIPT_DLL_API
232    void    void
233    copy(const Data& other);    copy(const Data& other);
234    
# Line 220  class Data { Line 238  class Data {
238    
239    /**    /**
240       \brief       \brief
241       Return the values of all data-points as a single python numarray object.       switches on update protection
242    
243    */    */
244    const boost::python::numeric::array    ESCRIPT_DLL_API
245    convertToNumArray();    void
246      setProtection();
247    
248    /**    /**
249       \brief       \brief
250       Return the values of all data-points for the given sample as a single python numarray object.       Returns trueif the data object is protected against update
251    
252    */    */
253    const boost::python::numeric::array    ESCRIPT_DLL_API
254    convertToNumArrayFromSampleNo(int sampleNo);    bool
255      isProtected() const;
256    
257    /**    /**
258       \brief       \brief
259       Return the value of the specified data-point as a single python numarray object.       Return the values of a data point on this process
260    */    */
261      ESCRIPT_DLL_API
262    const boost::python::numeric::array    const boost::python::numeric::array
263    convertToNumArrayFromDPNo(int sampleNo,    getValueOfDataPoint(int dataPointNo);
264                              int dataPointNo);  
265      /**
266         \brief
267         sets the values of a data-point from a python object on this process
268      */
269      ESCRIPT_DLL_API
270      void
271      setValueOfDataPointToPyObject(int dataPointNo, const boost::python::object& py_object);
272    
273      /**
274         \brief
275         sets the values of a data-point from a numarray object on this process
276      */
277      ESCRIPT_DLL_API
278      void
279      setValueOfDataPointToArray(int dataPointNo, const boost::python::numeric::array&);
280    
281    /**    /**
282       \brief       \brief
283       Fills the expanded Data object from values of a python numarray object.       sets the values of a data-point on this process
284    */    */
285      ESCRIPT_DLL_API
286    void    void
287    fillFromNumArray(const boost::python::numeric::array);    setValueOfDataPoint(int dataPointNo, const double);
288    
289      /**
290         \brief
291         Return the value of the specified data-point across all processors
292      */
293      ESCRIPT_DLL_API
294      const boost::python::numeric::array
295      getValueOfGlobalDataPoint(int procNo, int dataPointNo);
296    
297    /**    /**
298       \brief       \brief
# Line 254  class Data { Line 301  class Data {
301       The data-point number here corresponds to the data-point number in the       The data-point number here corresponds to the data-point number in the
302       numarray returned by convertToNumArray.       numarray returned by convertToNumArray.
303    */    */
304      ESCRIPT_DLL_API
305    int    int
306    getTagNumber(int dpno);    getTagNumber(int dpno);
307    
# Line 261  class Data { Line 309  class Data {
309       \brief       \brief
310       Return the C wrapper for the Data object.       Return the C wrapper for the Data object.
311    */    */
312      ESCRIPT_DLL_API
313    escriptDataC    escriptDataC
314    getDataC();    getDataC();
315    
# Line 268  class Data { Line 317  class Data {
317       \brief       \brief
318       Return the C wrapper for the Data object - const version.       Return the C wrapper for the Data object - const version.
319    */    */
320      ESCRIPT_DLL_API
321    escriptDataC    escriptDataC
322    getDataC() const;    getDataC() const;
323    
# Line 275  class Data { Line 325  class Data {
325       \brief       \brief
326       Write the data as a string.       Write the data as a string.
327    */    */
328      ESCRIPT_DLL_API
329    inline    inline
330    std::string    std::string
331    toString() const    toString() const
# Line 288  class Data { Line 339  class Data {
339       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
340       to manipulate the point data.       to manipulate the point data.
341    */    */
342      ESCRIPT_DLL_API
343    inline    inline
344    const DataArrayView&    const DataArrayView&
345    getPointDataView() const    getPointDataView() const
# Line 299  class Data { Line 351  class Data {
351       \brief       \brief
352       Whatever the current Data type make this into a DataExpanded.       Whatever the current Data type make this into a DataExpanded.
353    */    */
354      ESCRIPT_DLL_API
355    void    void
356    expand();    expand();
357    
# Line 307  class Data { Line 360  class Data {
360       If possible convert this Data to DataTagged. This will only allow       If possible convert this Data to DataTagged. This will only allow
361       Constant data to be converted to tagged. An attempt to convert       Constant data to be converted to tagged. An attempt to convert
362       Expanded data to tagged will throw an exception.       Expanded data to tagged will throw an exception.
363        ==>*
364    */    */
365      ESCRIPT_DLL_API
366    void    void
367    tag();    tag();
368    
# Line 315  class Data { Line 370  class Data {
370       \brief       \brief
371       Return true if this Data is expanded.       Return true if this Data is expanded.
372    */    */
373      ESCRIPT_DLL_API
374    bool    bool
375    isExpanded() const;    isExpanded() const;
376    
# Line 322  class Data { Line 378  class Data {
378       \brief       \brief
379       Return true if this Data is tagged.       Return true if this Data is tagged.
380    */    */
381      ESCRIPT_DLL_API
382    bool    bool
383    isTagged() const;    isTagged() const;
384    
# Line 329  class Data { Line 386  class Data {
386       \brief       \brief
387       Return true if this Data is constant.       Return true if this Data is constant.
388    */    */
389      ESCRIPT_DLL_API
390    bool    bool
391    isConstant() const;    isConstant() const;
392    
# Line 336  class Data { Line 394  class Data {
394       \brief       \brief
395       Return true if this Data is empty.       Return true if this Data is empty.
396    */    */
397      ESCRIPT_DLL_API
398    bool    bool
399    isEmpty() const;    isEmpty() const;
400    
# Line 343  class Data { Line 402  class Data {
402       \brief       \brief
403       Return the function space.       Return the function space.
404    */    */
405      ESCRIPT_DLL_API
406    inline    inline
407    const FunctionSpace&    const FunctionSpace&
408    getFunctionSpace() const    getFunctionSpace() const
# Line 354  class Data { Line 414  class Data {
414       \brief       \brief
415       Return a copy of the function space.       Return a copy of the function space.
416    */    */
417      ESCRIPT_DLL_API
418    const FunctionSpace    const FunctionSpace
419    getCopyOfFunctionSpace() const;    getCopyOfFunctionSpace() const;
420    
# Line 361  class Data { Line 422  class Data {
422       \brief       \brief
423       Return the domain.       Return the domain.
424    */    */
425      ESCRIPT_DLL_API
426    inline    inline
427    const AbstractDomain&    const AbstractDomain&
428    getDomain() const    getDomain() const
# Line 372  class Data { Line 434  class Data {
434       \brief       \brief
435       Return a copy of the domain.       Return a copy of the domain.
436    */    */
437      ESCRIPT_DLL_API
438    const AbstractDomain    const AbstractDomain
439    getCopyOfDomain() const;    getCopyOfDomain() const;
440    
# Line 379  class Data { Line 442  class Data {
442       \brief       \brief
443       Return the rank of the point data.       Return the rank of the point data.
444    */    */
445      ESCRIPT_DLL_API
446    inline    inline
447    int    int
448    getDataPointRank() const    getDataPointRank() const
# Line 388  class Data { Line 452  class Data {
452    
453    /**    /**
454       \brief       \brief
455         Return the number of data points
456      */
457      ESCRIPT_DLL_API
458      inline
459      int
460      getNumDataPoints() const
461      {
462        return getNumSamples() * getNumDataPointsPerSample();
463      }
464      /**
465         \brief
466       Return the number of samples.       Return the number of samples.
467    */    */
468      ESCRIPT_DLL_API
469    inline    inline
470    int    int
471    getNumSamples() const    getNumSamples() const
# Line 401  class Data { Line 477  class Data {
477       \brief       \brief
478       Return the number of data points per sample.       Return the number of data points per sample.
479    */    */
480      ESCRIPT_DLL_API
481    inline    inline
482    int    int
483    getNumDataPointsPerSample() const    getNumDataPointsPerSample() const
484    {    {
485      return m_data->getNumDPPSample();      return m_data->getNumDPPSample();
486    }    }
487      /**
488         \brief
489         dumps the object into a netCDF file
490      */
491      ESCRIPT_DLL_API
492      void
493      dump(const std::string fileName) const;
494    /**    /**
495       \brief       \brief
496       Return the sample data for the given sample no. This is not the       Return the sample data for the given sample no. This is not the
497       preferred interface but is provided for use by C code.       preferred interface but is provided for use by C code.
498       \param sampleNo - Input - the given sample no.       \param sampleNo - Input - the given sample no.
499    */    */
500      ESCRIPT_DLL_API
501    inline    inline
502    DataAbstract::ValueType::value_type*    DataAbstract::ValueType::value_type*
503    getSampleData(DataAbstract::ValueType::size_type sampleNo)    getSampleData(DataAbstract::ValueType::size_type sampleNo)
# Line 427  class Data { Line 511  class Data {
511       access data that isn't tagged an exception will be thrown.       access data that isn't tagged an exception will be thrown.
512       \param tag - Input - the tag key.       \param tag - Input - the tag key.
513    */    */
514      ESCRIPT_DLL_API
515    inline    inline
516    DataAbstract::ValueType::value_type*    DataAbstract::ValueType::value_type*
517    getSampleDataByTag(int tag)    getSampleDataByTag(int tag)
# Line 436  class Data { Line 521  class Data {
521    
522    /**    /**
523       \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  
524       Return a view into the data for the data point specified.       Return a view into the data for the data point specified.
525       NOTE: Construction of the DataArrayView is a relatively expensive       NOTE: Construction of the DataArrayView is a relatively expensive
526       operation.       operation.
527       \param sampleNo - Input -       \param sampleNo - Input -
528       \param dataPointNo - Input -       \param dataPointNo - Input -
529    */    */
530      ESCRIPT_DLL_API
531    inline    inline
532    DataArrayView    DataArrayView
533    getDataPoint(int sampleNo,    getDataPoint(int sampleNo,
534                 int dataPointNo)                 int dataPointNo)
535    {    {
536      return m_data->getDataPoint(sampleNo,dataPointNo);          return m_data->getDataPoint(sampleNo,dataPointNo);
537    }    }
538    
539    /**    /**
540       \brief       \brief
541       Return a reference to the data point shape.       Return a reference to the data point shape.
542    */    */
543      ESCRIPT_DLL_API
544    const DataArrayView::ShapeType&    const DataArrayView::ShapeType&
545    getDataPointShape() const;    getDataPointShape() const;
546    
# Line 500  class Data { Line 548  class Data {
548       \brief       \brief
549       Return the data point shape as a tuple of integers.       Return the data point shape as a tuple of integers.
550    */    */
551      ESCRIPT_DLL_API
552    const boost::python::tuple    const boost::python::tuple
553    getShapeTuple() const;    getShapeTuple() const;
554    
# Line 508  class Data { Line 557  class Data {
557       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
558       data point shape dimensions.       data point shape dimensions.
559    */    */
560      ESCRIPT_DLL_API
561    int    int
562    getDataPointSize() const;    getDataPointSize() const;
563    
# Line 515  class Data { Line 565  class Data {
565       \brief       \brief
566       Return the number of doubles stored for this Data.       Return the number of doubles stored for this Data.
567    */    */
568      ESCRIPT_DLL_API
569    DataArrayView::ValueType::size_type    DataArrayView::ValueType::size_type
570    getLength() const;    getLength() const;
571    
572    
573    
574      /**
575         \brief
576         Assign the given value to the tag assocciated with name. Implicitly converts this
577         object to type DataTagged. Throws an exception if this object
578         cannot be converted to a DataTagged object or name cannot be mapped onto a tag key.
579         \param tagKey - Input - Integer key.
580         \param value - Input - Value to associate with given key.
581        ==>*
582      */
583      ESCRIPT_DLL_API
584      void
585      setTaggedValueByName(std::string name,
586                           const boost::python::object& value);
587    
588    /**    /**
589       \brief       \brief
590       Assign the given value to the tag. Implicitly converts this       Assign the given value to the tag. Implicitly converts this
# Line 525  class Data { Line 592  class Data {
592       cannot be converted to a DataTagged object.       cannot be converted to a DataTagged object.
593       \param tagKey - Input - Integer key.       \param tagKey - Input - Integer key.
594       \param value - Input - Value to associate with given key.       \param value - Input - Value to associate with given key.
595        ==>*
596    */    */
597      ESCRIPT_DLL_API
598    void    void
599    setTaggedValue(int tagKey,    setTaggedValue(int tagKey,
600                   const boost::python::object& value);                   const boost::python::object& value);
# Line 537  class Data { Line 606  class Data {
606       cannot be converted to a DataTagged object.       cannot be converted to a DataTagged object.
607       \param tagKey - Input - Integer key.       \param tagKey - Input - Integer key.
608       \param value - Input - Value to associate with given key.       \param value - Input - Value to associate with given key.
609        ==>*
610    */    */
611      ESCRIPT_DLL_API
612    void    void
613    setTaggedValueFromCPP(int tagKey,    setTaggedValueFromCPP(int tagKey,
614                          const DataArrayView& value);                          const DataArrayView& value);
# Line 546  class Data { Line 617  class Data {
617      \brief      \brief
618      Copy other Data object into this Data object where mask is positive.      Copy other Data object into this Data object where mask is positive.
619    */    */
620      ESCRIPT_DLL_API
621    void    void
622    copyWithMask(const Data& other,    copyWithMask(const Data& other,
623                 const Data& mask);                 const Data& mask);
# Line 556  class Data { Line 628  class Data {
628    
629    /**    /**
630       \brief       \brief
631         set all values to zero
632         *
633      */
634      ESCRIPT_DLL_API
635      void
636      setToZero();
637    
638      /**
639         \brief
640       Interpolates this onto the given functionspace and returns       Interpolates this onto the given functionspace and returns
641       the result as a Data object.       the result as a Data object.
642       *       *
643    */    */
644      ESCRIPT_DLL_API
645    Data    Data
646    interpolate(const FunctionSpace& functionspace) const;    interpolate(const FunctionSpace& functionspace) const;
   
647    /**    /**
648       \brief       \brief
649       Calculates the gradient of the data at the data points of functionspace.       Calculates the gradient of the data at the data points of functionspace.
650       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.
651       *       *
652    */    */
653      ESCRIPT_DLL_API
654    Data    Data
655    gradOn(const FunctionSpace& functionspace) const;    gradOn(const FunctionSpace& functionspace) const;
656    
657      ESCRIPT_DLL_API
658    Data    Data
659    grad() const;    grad() const;
660    
# Line 580  class Data { Line 663  class Data {
663       Calculate the integral over the function space domain.       Calculate the integral over the function space domain.
664       *       *
665    */    */
666      ESCRIPT_DLL_API
667    boost::python::numeric::array    boost::python::numeric::array
668    integrate() const;    integrate() const;
669    
670    /**    /**
671       \brief       \brief
672         Returns 1./ Data object
673         *
674      */
675      ESCRIPT_DLL_API
676      Data
677      oneOver() const;
678      /**
679         \brief
680       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.
681       *       *
682    */    */
683      ESCRIPT_DLL_API
684    Data    Data
685    wherePositive() const;    wherePositive() const;
686    
# Line 596  class Data { Line 689  class Data {
689       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.
690       *       *
691    */    */
692      ESCRIPT_DLL_API
693    Data    Data
694    whereNegative() const;    whereNegative() const;
695    
# Line 604  class Data { Line 698  class Data {
698       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.
699       *       *
700    */    */
701      ESCRIPT_DLL_API
702    Data    Data
703    whereNonNegative() const;    whereNonNegative() const;
704    
# Line 612  class Data { Line 707  class Data {
707       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.
708       *       *
709    */    */
710      ESCRIPT_DLL_API
711    Data    Data
712    whereNonPositive() const;    whereNonPositive() const;
713    
# Line 620  class Data { Line 716  class Data {
716       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.
717       *       *
718    */    */
719      ESCRIPT_DLL_API
720    Data    Data
721    whereZero() const;    whereZero(double tol=0.0) const;
722    
723    /**    /**
724       \brief       \brief
725       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.
726       *       *
727    */    */
728      ESCRIPT_DLL_API
729    Data    Data
730    whereNonZero() const;    whereNonZero(double tol=0.0) const;
731    
732    /**    /**
733       \brief       \brief
734       Return the maximum absolute value of this Data object.       Return the maximum absolute value of this Data object.
735       *       *
736    */    */
737      ESCRIPT_DLL_API
738    double    double
739    Lsup() const;    Lsup() const;
740    
741    /**    /**
742       \brief       \brief
      Return the minimum absolute value of this Data object.  
      *  
   */  
   double  
   Linf() const;  
   
   /**  
      \brief  
743       Return the maximum value of this Data object.       Return the maximum value of this Data object.
744       *       *
745    */    */
746      ESCRIPT_DLL_API
747    double    double
748    sup() const;    sup() const;
749    
# Line 660  class Data { Line 752  class Data {
752       Return the minimum value of this Data object.       Return the minimum value of this Data object.
753       *       *
754    */    */
755      ESCRIPT_DLL_API
756    double    double
757    inf() const;    inf() const;
758    
# Line 668  class Data { Line 761  class Data {
761       Return the absolute value of each data point of this Data object.       Return the absolute value of each data point of this Data object.
762       *       *
763    */    */
764      ESCRIPT_DLL_API
765    Data    Data
766    abs() const;    abs() const;
767    
# Line 676  class Data { Line 770  class Data {
770       Return the maximum value of each data point of this Data object.       Return the maximum value of each data point of this Data object.
771       *       *
772    */    */
773      ESCRIPT_DLL_API
774    Data    Data
775    maxval() const;    maxval() const;
776    
# Line 684  class Data { Line 779  class Data {
779       Return the minimum value of each data point of this Data object.       Return the minimum value of each data point of this Data object.
780       *       *
781    */    */
782      ESCRIPT_DLL_API
783    Data    Data
784    minval() const;    minval() const;
785    
# Line 692  class Data { Line 788  class Data {
788       Return the (sample number, data-point number) of the data point with       Return the (sample number, data-point number) of the data point with
789       the minimum value in this Data object.       the minimum value in this Data object.
790    */    */
791      ESCRIPT_DLL_API
792    const boost::python::tuple    const boost::python::tuple
793    mindp() const;    minGlobalDataPoint() const;
794    
795      ESCRIPT_DLL_API
796    void    void
797    calc_mindp(int& SampleNo,    calc_minGlobalDataPoint(int& ProcNo,  int& DataPointNo) const;
798               int& DataPointNo) const;    /**
799         \brief
800         Return the sign of each data point of this Data object.
801         -1 for negative values, zero for zero values, 1 for positive values.
802         *
803      */
804      ESCRIPT_DLL_API
805      Data
806      sign() const;
807    
808    /**    /**
809       \brief       \brief
810       Return the length of each data point of this Data object.       Return the symmetric part of a matrix which is half the matrix plus its transpose.
      sqrt(sum(A[i,j,k,l]^2))  
811       *       *
812    */    */
813      ESCRIPT_DLL_API
814    Data    Data
815    length() const;    symmetric() const;
816    
817    /**    /**
818       \brief       \brief
819       Return the sign of each data point of this Data object.       Return the nonsymmetric part of a matrix which is half the matrix minus its transpose.
      -1 for negative values, zero for zero values, 1 for positive values.  
820       *       *
821    */    */
822      ESCRIPT_DLL_API
823    Data    Data
824    sign() const;    nonsymmetric() const;
825    
826      /**
827         \brief
828         Return the trace of a matrix
829         *
830      */
831      ESCRIPT_DLL_API
832      Data
833      trace(int axis_offset) const;
834    
835    /**    /**
836       \brief       \brief
837       Transpose each data point of this Data object around the given axis.       Transpose each data point of this Data object around the given axis.
      --* not implemented yet *--  
838       *       *
839    */    */
840      ESCRIPT_DLL_API
841      Data
842      transpose(int axis_offset) const;
843    
844      /**
845         \brief
846         Return the eigenvalues of the symmetric part at each data point of this Data object in increasing values.
847         Currently this function is restricted to rank 2, square shape, and dimension 3.
848         *
849      */
850      ESCRIPT_DLL_API
851      Data
852      eigenvalues() const;
853    
854      /**
855         \brief
856         Return the eigenvalues and corresponding eigenvcetors of the symmetric part at each data point of this Data object.
857         the eigenvalues are ordered in increasing size where eigenvalues with relative difference less than
858         tol are treated as equal. The eigenvectors are orthogonal, normalized and the sclaed such that the
859         first non-zero entry is positive.
860         Currently this function is restricted to rank 2, square shape, and dimension 3
861         *
862      */
863      ESCRIPT_DLL_API
864      const boost::python::tuple
865      eigenvalues_and_eigenvectors(const double tol=1.e-12) const;
866    
867      /**
868         \brief
869         swaps the components axis0 and axis1
870         *
871      */
872      ESCRIPT_DLL_API
873    Data    Data
874    transpose(int axis) const;    swapaxes(const int axis0, const int axis1) const;
875    
876    /**    /**
877       \brief       \brief
878       Calculate the trace of each data point of this Data object.       Return the error function erf of each data point of this Data object.
      sum(A[i,i,i,i])  
879       *       *
880    */    */
881      ESCRIPT_DLL_API
882    Data    Data
883    trace() const;    erf() const;
884    
885    /**    /**
886       \brief       \brief
887       Return the sin of each data point of this Data object.       Return the sin of each data point of this Data object.
888       *       *
889    */    */
890      ESCRIPT_DLL_API
891    Data    Data
892    sin() const;    sin() const;
893    
# Line 748  class Data { Line 896  class Data {
896       Return the cos of each data point of this Data object.       Return the cos of each data point of this Data object.
897       *       *
898    */    */
899      ESCRIPT_DLL_API
900    Data    Data
901    cos() const;    cos() const;
902    
# Line 756  class Data { Line 905  class Data {
905       Return the tan of each data point of this Data object.       Return the tan of each data point of this Data object.
906       *       *
907    */    */
908      ESCRIPT_DLL_API
909    Data    Data
910    tan() const;    tan() const;
911    
912    /**    /**
913       \brief       \brief
914         Return the asin of each data point of this Data object.
915         *
916      */
917      ESCRIPT_DLL_API
918      Data
919      asin() const;
920    
921      /**
922         \brief
923         Return the acos of each data point of this Data object.
924         *
925      */
926      ESCRIPT_DLL_API
927      Data
928      acos() const;
929    
930      /**
931         \brief
932         Return the atan of each data point of this Data object.
933         *
934      */
935      ESCRIPT_DLL_API
936      Data
937      atan() const;
938    
939      /**
940         \brief
941         Return the sinh of each data point of this Data object.
942         *
943      */
944      ESCRIPT_DLL_API
945      Data
946      sinh() const;
947    
948      /**
949         \brief
950         Return the cosh of each data point of this Data object.
951         *
952      */
953      ESCRIPT_DLL_API
954      Data
955      cosh() const;
956    
957      /**
958         \brief
959         Return the tanh of each data point of this Data object.
960         *
961      */
962      ESCRIPT_DLL_API
963      Data
964      tanh() const;
965    
966      /**
967         \brief
968         Return the asinh of each data point of this Data object.
969         *
970      */
971      ESCRIPT_DLL_API
972      Data
973      asinh() const;
974    
975      /**
976         \brief
977         Return the acosh of each data point of this Data object.
978         *
979      */
980      ESCRIPT_DLL_API
981      Data
982      acosh() const;
983    
984      /**
985         \brief
986         Return the atanh of each data point of this Data object.
987         *
988      */
989      ESCRIPT_DLL_API
990      Data
991      atanh() const;
992    
993      /**
994         \brief
995       Return the log to base 10 of each data point of this Data object.       Return the log to base 10 of each data point of this Data object.
996       *       *
997    */    */
998      ESCRIPT_DLL_API
999    Data    Data
1000    log() const;    log10() const;
1001    
1002    /**    /**
1003       \brief       \brief
1004       Return the natural log of each data point of this Data object.       Return the natural log of each data point of this Data object.
1005       *       *
1006    */    */
1007      ESCRIPT_DLL_API
1008    Data    Data
1009    ln() const;    log() const;
1010    
1011    /**    /**
1012       \brief       \brief
1013       Return the exponential function of each data point of this Data object.       Return the exponential function of each data point of this Data object.
1014       *       *
1015    */    */
1016      ESCRIPT_DLL_API
1017    Data    Data
1018    exp() const;    exp() const;
1019    
# Line 788  class Data { Line 1022  class Data {
1022       Return the square root of each data point of this Data object.       Return the square root of each data point of this Data object.
1023       *       *
1024    */    */
1025      ESCRIPT_DLL_API
1026    Data    Data
1027    sqrt() const;    sqrt() const;
1028    
# Line 796  class Data { Line 1031  class Data {
1031       Return the negation of each data point of this Data object.       Return the negation of each data point of this Data object.
1032       *       *
1033    */    */
1034      ESCRIPT_DLL_API
1035    Data    Data
1036    neg() const;    neg() const;
1037    
# Line 805  class Data { Line 1041  class Data {
1041       Simply returns this object unmodified.       Simply returns this object unmodified.
1042       *       *
1043    */    */
1044      ESCRIPT_DLL_API
1045    Data    Data
1046    pos() const;    pos() const;
1047    
# Line 815  class Data { Line 1052  class Data {
1052       \param right Input - the power to raise the object to.       \param right Input - the power to raise the object to.
1053       *       *
1054    */    */
1055      ESCRIPT_DLL_API
1056    Data    Data
1057    powD(const Data& right) const;    powD(const Data& right) const;
1058    
# Line 825  class Data { Line 1063  class Data {
1063       \param right Input - the power to raise the object to.       \param right Input - the power to raise the object to.
1064       *       *
1065     */     */
1066      ESCRIPT_DLL_API
1067    Data    Data
1068    powO(const boost::python::object& right) const;    powO(const boost::python::object& right) const;
1069    
1070    /**    /**
1071       \brief       \brief
1072         Return the given power of each data point of this boost python object.
1073        
1074         \param left Input - the bases
1075         *
1076       */
1077    
1078      ESCRIPT_DLL_API
1079      Data
1080      rpowO(const boost::python::object& left) const;
1081    
1082      /**
1083         \brief
1084       writes the object to a file in the DX file format       writes the object to a file in the DX file format
1085    */    */
1086      ESCRIPT_DLL_API
1087    void    void
1088    saveDX(std::string fileName) const;    saveDX(std::string fileName) const;
1089    
# Line 839  class Data { Line 1091  class Data {
1091       \brief       \brief
1092       writes the object to a file in the VTK file format       writes the object to a file in the VTK file format
1093    */    */
1094      ESCRIPT_DLL_API
1095    void    void
1096    saveVTK(std::string fileName) const;    saveVTK(std::string fileName) const;
1097    
# Line 848  class Data { Line 1101  class Data {
1101       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1102       *       *
1103    */    */
1104      ESCRIPT_DLL_API
1105    Data& operator+=(const Data& right);    Data& operator+=(const Data& right);
1106      ESCRIPT_DLL_API
1107    Data& operator+=(const boost::python::object& right);    Data& operator+=(const boost::python::object& right);
1108    
1109      ESCRIPT_DLL_API
1110      Data& operator=(const Data& other);
1111    
1112    /**    /**
1113       \brief       \brief
1114       Overloaded operator -=       Overloaded operator -=
1115       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1116       *       *
1117    */    */
1118      ESCRIPT_DLL_API
1119    Data& operator-=(const Data& right);    Data& operator-=(const Data& right);
1120      ESCRIPT_DLL_API
1121    Data& operator-=(const boost::python::object& right);    Data& operator-=(const boost::python::object& right);
1122    
1123   /**   /**
# Line 866  class Data { Line 1126  class Data {
1126       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1127       *       *
1128    */    */
1129      ESCRIPT_DLL_API
1130    Data& operator*=(const Data& right);    Data& operator*=(const Data& right);
1131      ESCRIPT_DLL_API
1132    Data& operator*=(const boost::python::object& right);    Data& operator*=(const boost::python::object& right);
1133    
1134   /**   /**
# Line 875  class Data { Line 1137  class Data {
1137       \param right - Input - The right hand side.       \param right - Input - The right hand side.
1138       *       *
1139    */    */
1140      ESCRIPT_DLL_API
1141    Data& operator/=(const Data& right);    Data& operator/=(const Data& right);
1142      ESCRIPT_DLL_API
1143    Data& operator/=(const boost::python::object& right);    Data& operator/=(const boost::python::object& right);
1144    
1145    /**    /**
1146       \brief       \brief
1147       Returns true if this can be interpolated to functionspace.       Returns true if this can be interpolated to functionspace.
1148    */    */
1149      ESCRIPT_DLL_API
1150    bool    bool
1151    probeInterpolation(const FunctionSpace& functionspace) const;    probeInterpolation(const FunctionSpace& functionspace) const;
1152    
# Line 900  class Data { Line 1165  class Data {
1165       \param key - Input - python slice tuple specifying       \param key - Input - python slice tuple specifying
1166       slice to return.       slice to return.
1167    */    */
1168      ESCRIPT_DLL_API
1169    Data    Data
1170    getItem(const boost::python::object& key) const;    getItem(const boost::python::object& key) const;
1171    
# Line 914  class Data { Line 1180  class Data {
1180       slice to copy from value.       slice to copy from value.
1181       \param value - Input - Data object to copy from.       \param value - Input - Data object to copy from.
1182    */    */
1183      ESCRIPT_DLL_API
1184    void    void
1185    setItemD(const boost::python::object& key,    setItemD(const boost::python::object& key,
1186             const Data& value);             const Data& value);
1187    
1188      ESCRIPT_DLL_API
1189    void    void
1190    setItemO(const boost::python::object& key,    setItemO(const boost::python::object& key,
1191             const boost::python::object& value);             const boost::python::object& value);
# Line 930  class Data { Line 1198  class Data {
1198       this Data object.       this Data object.
1199    */    */
1200    template <class UnaryFunction>    template <class UnaryFunction>
1201      ESCRIPT_DLL_API
1202    inline    inline
1203    void    void
1204    unaryOp(UnaryFunction operation);    unaryOp(UnaryFunction operation);
# Line 941  class Data { Line 1210  class Data {
1210       \param region - Input - Region to copy.       \param region - Input - Region to copy.
1211       *       *
1212    */    */
1213      ESCRIPT_DLL_API
1214    Data    Data
1215    getSlice(const DataArrayView::RegionType& region) const;    getSlice(const DataArrayView::RegionType& region) const;
1216    
# Line 952  class Data { Line 1222  class Data {
1222       \param region - Input - Region to copy.       \param region - Input - Region to copy.
1223       *       *
1224    */    */
1225      ESCRIPT_DLL_API
1226    void    void
1227    setSlice(const Data& value,    setSlice(const Data& value,
1228             const DataArrayView::RegionType& region);             const DataArrayView::RegionType& region);
# Line 961  class Data { Line 1232  class Data {
1232       Archive the current Data object to the given file.       Archive the current Data object to the given file.
1233       \param fileName - Input - file to archive to.       \param fileName - Input - file to archive to.
1234    */    */
1235      ESCRIPT_DLL_API
1236    void    void
1237    archiveData(const std::string fileName);    archiveData(const std::string fileName);
1238    
# Line 972  class Data { Line 1244  class Data {
1244       \param fileName - Input - file to extract from.       \param fileName - Input - file to extract from.
1245       \param fspace - Input - a suitable FunctionSpace descibing the data.       \param fspace - Input - a suitable FunctionSpace descibing the data.
1246    */    */
1247      ESCRIPT_DLL_API
1248    void    void
1249    extractData(const std::string fileName,    extractData(const std::string fileName,
1250                const FunctionSpace& fspace);                const FunctionSpace& fspace);
1251    
1252    
1253      /**
1254         \brief
1255         print the data values to stdout. Used for debugging
1256      */
1257      ESCRIPT_DLL_API
1258      void
1259        print(void);
1260    
1261      /**
1262         \brief
1263         return the MPI rank number of the local data
1264             MPI_COMM_WORLD is assumed and the result of MPI_Comm_size()
1265             is returned
1266      */
1267      ESCRIPT_DLL_API
1268        int
1269        get_MPIRank(void) const;
1270    
1271      /**
1272         \brief
1273         return the MPI rank number of the local data
1274             MPI_COMM_WORLD is assumed and the result of MPI_Comm_rank()
1275             is returned
1276      */
1277      ESCRIPT_DLL_API
1278        int
1279        get_MPISize(void) const;
1280    
1281      /**
1282         \brief
1283         return the MPI rank number of the local data
1284             MPI_COMM_WORLD is assumed and returned.
1285      */
1286      ESCRIPT_DLL_API
1287        MPI_Comm
1288        get_MPIComm(void) const;
1289    
1290      /**
1291         \brief
1292         return the object produced by the factory, which is a DataConstant or DataExpanded
1293      */
1294      ESCRIPT_DLL_API
1295        DataAbstract*
1296        borrowData(void) const;
1297    
1298   protected:   protected:
1299    
1300   private:   private:
# Line 1033  class Data { Line 1352  class Data {
1352    
1353    /**    /**
1354       \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  
1355       Convert the data type of the RHS to match this.       Convert the data type of the RHS to match this.
1356       \param right - Input - data type to match.       \param right - Input - data type to match.
1357    */    */
# Line 1068  class Data { Line 1376  class Data {
1376               const FunctionSpace& what,               const FunctionSpace& what,
1377               bool expanded);               bool expanded);
1378    
1379    /**    //
1380       \brief    // flag to protect the data object against any update
1381       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);  
1382    
1383    //    //
1384    // pointer to the actual data object    // pointer to the actual data object
1385    boost::shared_ptr<DataAbstract> m_data;    boost::shared_ptr<DataAbstract> m_data;
1386    
   //  
   // pointer to the internal profiling data  
   struct profDataEntry *profData;  
   
1387  };  };
1388    
1389  template <class IValueType>  template <class IValueType>
# Line 1113  Data::initialise(const IValueType& value Line 1411  Data::initialise(const IValueType& value
1411  /**  /**
1412     Binary Data object operators.     Binary Data object operators.
1413  */  */
1414    inline double rpow(double x,double y)
1415    {
1416        return pow(y,x);
1417    }
1418    
1419  /**  /**
1420    \brief    \brief
1421    Operator+    Operator+
1422    Takes two Data objects.    Takes two Data objects.
1423  */  */
1424  Data operator+(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator+(const Data& left, const Data& right);
1425    
1426  /**  /**
1427    \brief    \brief
1428    Operator-    Operator-
1429    Takes two Data objects.    Takes two Data objects.
1430  */  */
1431  Data operator-(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator-(const Data& left, const Data& right);
1432    
1433  /**  /**
1434    \brief    \brief
1435    Operator*    Operator*
1436    Takes two Data objects.    Takes two Data objects.
1437  */  */
1438  Data operator*(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator*(const Data& left, const Data& right);
1439    
1440  /**  /**
1441    \brief    \brief
1442    Operator/    Operator/
1443    Takes two Data objects.    Takes two Data objects.
1444  */  */
1445  Data operator/(const Data& left, const Data& right);  ESCRIPT_DLL_API Data operator/(const Data& left, const Data& right);
1446    
1447  /**  /**
1448    \brief    \brief
# Line 1148  Data operator/(const Data& left, const D Line 1450  Data operator/(const Data& left, const D
1450    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1451    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1452  */  */
1453  Data operator+(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator+(const Data& left, const boost::python::object& right);
1454    
1455  /**  /**
1456    \brief    \brief
# Line 1156  Data operator+(const Data& left, const b Line 1458  Data operator+(const Data& left, const b
1458    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1459    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1460  */  */
1461  Data operator-(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator-(const Data& left, const boost::python::object& right);
1462    
1463  /**  /**
1464    \brief    \brief
# Line 1164  Data operator-(const Data& left, const b Line 1466  Data operator-(const Data& left, const b
1466    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1467    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1468  */  */
1469  Data operator*(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator*(const Data& left, const boost::python::object& right);
1470    
1471  /**  /**
1472    \brief    \brief
# Line 1172  Data operator*(const Data& left, const b Line 1474  Data operator*(const Data& left, const b
1474    Takes LHS Data object and RHS python::object.    Takes LHS Data object and RHS python::object.
1475    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1476  */  */
1477  Data operator/(const Data& left, const boost::python::object& right);  ESCRIPT_DLL_API Data operator/(const Data& left, const boost::python::object& right);
1478    
1479  /**  /**
1480    \brief    \brief
# Line 1180  Data operator/(const Data& left, const b Line 1482  Data operator/(const Data& left, const b
1482    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1483    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1484  */  */
1485  Data operator+(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator+(const boost::python::object& left, const Data& right);
1486    
1487  /**  /**
1488    \brief    \brief
# Line 1188  Data operator+(const boost::python::obje Line 1490  Data operator+(const boost::python::obje
1490    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1491    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1492  */  */
1493  Data operator-(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator-(const boost::python::object& left, const Data& right);
1494    
1495  /**  /**
1496    \brief    \brief
# Line 1196  Data operator-(const boost::python::obje Line 1498  Data operator-(const boost::python::obje
1498    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1499    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1500  */  */
1501  Data operator*(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator*(const boost::python::object& left, const Data& right);
1502    
1503  /**  /**
1504    \brief    \brief
# Line 1204  Data operator*(const boost::python::obje Line 1506  Data operator*(const boost::python::obje
1506    Takes LHS python::object and RHS Data object.    Takes LHS python::object and RHS Data object.
1507    python::object must be convertable to Data type.    python::object must be convertable to Data type.
1508  */  */
1509  Data operator/(const boost::python::object& left, const Data& right);  ESCRIPT_DLL_API Data operator/(const boost::python::object& left, const Data& right);
1510    
1511    
1512    
1513  /**  /**
1514    \brief    \brief
1515    Output operator    Output operator
1516  */  */
1517  std::ostream& operator<<(std::ostream& o, const Data& data);  ESCRIPT_DLL_API std::ostream& operator<<(std::ostream& o, const Data& data);
1518    
1519    /**
1520      \brief
1521      Compute a tensor product of two Data objects
1522      \param arg0 - Input - Data object
1523      \param arg1 - Input - Data object
1524      \param axis_offset - Input - axis offset
1525      \param transpose - Input - 0: transpose neither, 1: transpose arg0, 2: transpose arg1
1526    */
1527    ESCRIPT_DLL_API
1528    Data
1529    C_GeneralTensorProduct(Data& arg0,
1530                         Data& arg1,
1531                         int axis_offset=0,
1532                         int transpose=0);
1533    
1534  /**  /**
1535    \brief    \brief
# Line 1218  std::ostream& operator<<(std::ostream& o Line 1537  std::ostream& operator<<(std::ostream& o
1537    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
1538    be relied on. Requires further implementation.    be relied on. Requires further implementation.
1539  */  */
1540  //bool operator==(const Data& left, const Data& right);  // ESCRIPT_DLL_API bool operator==(const Data& left, const Data& right);
1541    
1542  /**  /**
1543    \brief    \brief
# Line 1234  Data::binaryOp(const Data& right, Line 1553  Data::binaryOp(const Data& right,
1553     //     //
1554     // 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
1555     if (getPointDataView().getRank()==0 && right.getPointDataView().getRank()!=0) {     if (getPointDataView().getRank()==0 && right.getPointDataView().getRank()!=0) {
1556       reshapeDataPoint(right.getPointDataView().getShape());       throw DataException("Error - attempt to update rank zero object with object with rank bigger than zero.");
1557     }     }
1558     //     //
1559     // initially make the temporary a shallow copy     // initially make the temporary a shallow copy
# Line 1290  Data::binaryOp(const Data& right, Line 1609  Data::binaryOp(const Data& right,
1609    
1610  /**  /**
1611    \brief    \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);  
    }  
 }  
   
 /**  
   \brief  
1612    Perform the given unary operation on other and return the result.    Perform the given unary operation on other and return the result.
1613    Given operation is performed on each element of each data point, thus    Given operation is performed on each element of each data point, thus
1614    argument object is a rank n Data object, and returned object is a rank n    argument object is a rank n Data object, and returned object is a rank n
# Line 1415  inline Line 1694  inline
1694  Data  Data
1695  Data::dp_algorithm(BinaryFunction operation, double initial_value) 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,initial_value);      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,initial_value);      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,initial_value);      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.149  
changed lines
  Added in v.1312

  ViewVC Help
Powered by ViewVC 1.1.26