SundanceFunctionalEvaluatorBase.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  * FunctionalEvaluatorBase.hpp
00032  *
00033  *  Created on: Jun 20, 2011
00034  *      Author: benk
00035  */
00036 
00037 #ifndef FUNCTIONALEVALUATORBASE_HPP_
00038 #define FUNCTIONALEVALUATORBASE_HPP_
00039 
00040 #include "SundanceExpr.hpp"
00041 
00042 namespace Sundance
00043 {
00044 
00045 /** Abstract interface for the FunctionalEvaluator class
00046  * it contains only empty functions */
00047 class FunctionalEvaluatorBase
00048 {
00049 public:
00050   /** */
00051   FunctionalEvaluatorBase() {;}
00052 
00053   /** */
00054   virtual double evaluate() const { return 0.0; }
00055 
00056   /** */
00057   virtual Expr evalGradient(double& value) const { return Expr(0.0); }
00058 
00059   /** */
00060   virtual double fdGradientCheck(double h) const { return 0.0; }
00061 };
00062 }
00063 #endif /* FUNCTIONALEVALUATORBASE_HPP_ */

Site Contact