SundanceSumTransformation.hpp
Go to the documentation of this file.
00001 /* @HEADER@ */
00002 // ************************************************************************
00003 // 
00004 //                              Sundance
00005 //                 Copyright (2005) Sandia Corporation
00006 // 
00007 // Copyright (year first published) Sandia Corporation.  Under the terms 
00008 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 
00009 // retains certain rights in this software.
00010 // 
00011 // This library is free software; you can redistribute it and/or modify
00012 // it under the terms of the GNU Lesser General Public License as
00013 // published by the Free Software Foundation; either version 2.1 of the
00014 // License, or (at your option) any later version.
00015 //  
00016 // This library is distributed in the hope that it will be useful, but
00017 // WITHOUT ANY WARRANTY; without even the implied warranty of
00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 // Lesser General Public License for more details.
00020 //                                                                                 
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License along with this library; if not, write to the Free Software
00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 // USA                                                                                
00025 // Questions? Contact Kevin Long (krlong@sandia.gov), 
00026 // Sandia National Laboratories, Livermore, California, USA
00027 // 
00028 // ************************************************************************
00029 /* @HEADER@ */
00030 
00031 #ifndef SUNDANCE_SUMTRANSFORMATION_H
00032 #define SUNDANCE_SUMTRANSFORMATION_H
00033 
00034 #include "SundanceDefs.hpp"
00035 #include "SundanceSymbolicTransformation.hpp"
00036 
00037 namespace Sundance
00038 {
00039 using namespace Sundance;
00040 using namespace Teuchos;
00041 
00042 
00043 
00044 
00045 /** 
00046  * SumTransformation is a base class for any transformation
00047  * which takes the two operands of a sum (left, right) and produces
00048  * a new expression mathematically equivalent to the original
00049  * sum. This will be used to effect simplification
00050  * transformations on sum expressions.
00051  */
00052 class SumTransformation : public SymbolicTransformation
00053 {
00054 public:
00055   /** */
00056   SumTransformation();
00057 
00058   /** */
00059   virtual ~SumTransformation(){;}
00060 
00061   /** 
00062    * Test whether the transform is applicable in this case,
00063    * and if it is, apply it. The return value is true is the
00064    * transformation was applied, otherwise false. 
00065    * Returns by non-const reference
00066    * the transformed expression. 
00067    * 
00068    */
00069   virtual bool doTransform(const RCP<ScalarExpr>& left, 
00070     const RCP<ScalarExpr>& right,
00071     int sign, RCP<ScalarExpr>& rtn) const = 0 ;
00072 };
00073 }
00074 
00075 #endif

Site Contact