SundanceSumTransformationSequence.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_SUMTRANSFORMATIONSEQUENCE_H
00032 #define SUNDANCE_SUMTRANSFORMATIONSEQUENCE_H
00033 
00034 #include "SundanceDefs.hpp"
00035 #include "SundanceSumTransformation.hpp"
00036 #include "Teuchos_Array.hpp"
00037 
00038 namespace Sundance
00039 {
00040 using namespace Sundance;
00041 using namespace Teuchos;
00042 
00043 
00044 
00045 
00046 /** 
00047  * SumTransformationSequence is a sequence of transformations
00048  * to be applied to a sum, producing a transformed expression. 
00049  */
00050 class SumTransformationSequence : public SumTransformation,
00051                                   public Array<RCP<SumTransformation> >
00052 {
00053 public:
00054   /** */
00055   SumTransformationSequence();
00056 
00057   /** */
00058   virtual ~SumTransformationSequence(){;}
00059 
00060   /**
00061    * Test whether the transform is applicable in this case,
00062    * and if it is, apply it. The return value is true is the
00063    * transformation was applied, otherwise false. 
00064    * Returns by non-const reference
00065    * the transformed expression. 
00066    *
00067    * For SumTransformationSequence, this is implemented by
00068    * trying to apply all transformations in sequence. If one
00069    * succeeds, we exit immediately with true.
00070    */
00071   virtual bool doTransform(const RCP<ScalarExpr>& left, 
00072     const RCP<ScalarExpr>& right,
00073     int sign, RCP<ScalarExpr>& rtn) const ;
00074 
00075         
00076 };
00077 }
00078 
00079 #endif

Site Contact