SFadUnitTests.hpp

Go to the documentation of this file.

// $Id: SFadUnitTests.hpp,v 1.6 2007/06/29 22:18:34 etphipp Exp $ 
// $Source: /space/CVS/Trilinos/packages/sacado/test/TestSuite/SFadUnitTests.hpp,v $ 
// @HEADER
// ***********************************************************************
// 
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef SFADUNITTESTS_HPP
#define SFADUNITTESTS_HPP

// Sacado includes
#include "Sacado.hpp"
#include "Sacado_Random.hpp"

const int num_comp = 5;
typedef Sacado::Fad::SFad<double,num_comp> SFadType;

// Fad includes
#include "Fad/fad.h"

// Cppunit includes
#include <cppunit/extensions/HelperMacros.h>

#define BINARY_OP_TEST(TESTNAME,OP) \
  void TESTNAME () {        \
    c_sfad = a_sfad OP b_sfad;      \
    c_fad = a_fad OP b_fad;     \
    compareFads(c_sfad, c_fad);     \
            \
    double val = urand.number();    \
    c_sfad = a_sfad OP val;     \
    c_fad = a_fad OP val;     \
    compareFads(c_sfad, c_fad);     \
            \
    c_sfad = val OP b_sfad;     \
    c_fad = val OP b_fad;     \
    compareFads(c_sfad, c_fad);     \
  }

#define RELOP_TEST(TESTNAME,OP)     \
  void TESTNAME () {        \
    bool r1 = a_sfad OP b_sfad;     \
    bool r2 = a_fad OP b_fad;     \
    CPPUNIT_ASSERT(r1 == r2);     \
            \
    double val = urand.number();    \
    r1 = a_sfad OP val;             \
    r2 = a_fad OP val;              \
    CPPUNIT_ASSERT(r1 == r2);     \
            \
    r1 = val OP b_sfad;             \
    r2 = val OP b_fad;              \
    CPPUNIT_ASSERT(r1 == r2);     \
  }

#define BINARY_FUNC_TEST(TESTNAME,FUNC) \
  void TESTNAME () {      \
    c_sfad = FUNC (a_sfad,b_sfad);  \
    c_fad = FUNC (a_fad,b_fad);   \
    compareFads(c_sfad, c_fad);   \
              \
    double val = urand.number();  \
    c_sfad = FUNC (a_sfad,val);   \
    c_fad = FUNC (a_fad,val);   \
    compareFads(c_sfad, c_fad);   \
              \
    c_sfad = FUNC (val,b_sfad);   \
    c_fad = FUNC (val,b_fad);   \
    compareFads(c_sfad, c_fad);   \
  }

#define UNARY_OP_TEST(TESTNAME,OP)      \
  void TESTNAME () {          \
    c_sfad = OP a_sfad;         \
    c_fad = OP a_fad;         \
    compareFads(c_sfad, c_fad);       \
  }

#define UNARY_FUNC_TEST(TESTNAME,FUNC)      \
  void TESTNAME () {          \
    c_sfad = FUNC (a_sfad);       \
    c_fad = FUNC (a_fad);       \
    compareFads(c_sfad, c_fad);       \
  }

#define UNARY_ASSIGNOP_TEST(TESTNAME,OP)    \
  void TESTNAME () {          \
    c_sfad OP a_sfad;         \
    c_fad OP a_fad;         \
    compareFads(c_sfad, c_fad);       \
              \
    double val = urand.number();      \
    c_sfad OP val;          \
    c_fad OP val;         \
    compareFads(c_sfad, c_fad);       \
  }

// A class for testing each SFad operation
class SFadOpsUnitTest : public CppUnit::TestFixture {

  CPPUNIT_TEST_SUITE( SFadOpsUnitTest );
  
  CPPUNIT_TEST(testAddition);
  CPPUNIT_TEST(testSubtraction);
  CPPUNIT_TEST(testMultiplication);
  CPPUNIT_TEST(testDivision);

  CPPUNIT_TEST(testEquals);
  CPPUNIT_TEST(testNotEquals);
  CPPUNIT_TEST(testLessThanOrEquals);
  CPPUNIT_TEST(testGreaterThanOrEquals);
  CPPUNIT_TEST(testLessThan);
  CPPUNIT_TEST(testGreaterThan);

  CPPUNIT_TEST(testPow);
  CPPUNIT_TEST(testMax);
  CPPUNIT_TEST(testMin);

  CPPUNIT_TEST(testUnaryPlus);
  CPPUNIT_TEST(testUnaryMinus);
  
  CPPUNIT_TEST(testExp);
  CPPUNIT_TEST(testLog);
  CPPUNIT_TEST(testLog10);
  CPPUNIT_TEST(testSqrt);
  CPPUNIT_TEST(testCos);
  CPPUNIT_TEST(testSin);
  CPPUNIT_TEST(testTan);
  CPPUNIT_TEST(testACos);
  CPPUNIT_TEST(testASin);
  CPPUNIT_TEST(testATan);
  CPPUNIT_TEST(testCosh);
  CPPUNIT_TEST(testSinh);
  CPPUNIT_TEST(testTanh);
  CPPUNIT_TEST(testAbs);
  CPPUNIT_TEST(testFAbs);

  CPPUNIT_TEST(testPlusEquals);
  CPPUNIT_TEST(testMinusEquals);
  CPPUNIT_TEST(testTimesEquals);
  CPPUNIT_TEST(testDivideEquals);

  CPPUNIT_TEST(testComposite1);

  CPPUNIT_TEST(testPlusLR);
  CPPUNIT_TEST(testMinusLR);
  CPPUNIT_TEST(testTimesLR);
  CPPUNIT_TEST(testDivideLR);

  CPPUNIT_TEST_SUITE_END();

public:

  SFadOpsUnitTest();

  SFadOpsUnitTest(int numComponents, double absolute_tolerance, 
      double relative_tolerance);

  void setUp();

  void tearDown();

  // Assert to Fad objects are the same
  void compareFads(const SFadType& x_sfad,
       const FAD::Fad<double>& x_fad);

  // Assert to doubles are the same to relative precision
  void compareDoubles(double a, double b);

  BINARY_OP_TEST(testAddition, +);
  BINARY_OP_TEST(testSubtraction, -);
  BINARY_OP_TEST(testMultiplication, *);
  BINARY_OP_TEST(testDivision, /);

  RELOP_TEST(testEquals, ==);
  RELOP_TEST(testNotEquals, !=);
  RELOP_TEST(testLessThanOrEquals, <=);
  RELOP_TEST(testGreaterThanOrEquals, >=);
  RELOP_TEST(testLessThan, <);
  RELOP_TEST(testGreaterThan, >);

  BINARY_FUNC_TEST(testPow, pow);

  UNARY_OP_TEST(testUnaryPlus, +);
  UNARY_OP_TEST(testUnaryMinus, -);

  UNARY_FUNC_TEST(testExp, exp);
  UNARY_FUNC_TEST(testLog, log);
  UNARY_FUNC_TEST(testLog10, log10);
  UNARY_FUNC_TEST(testSqrt, sqrt);
  UNARY_FUNC_TEST(testCos, cos);
  UNARY_FUNC_TEST(testSin, sin);
  UNARY_FUNC_TEST(testTan, tan);
  UNARY_FUNC_TEST(testACos, acos);
  UNARY_FUNC_TEST(testASin, asin);
  UNARY_FUNC_TEST(testATan, atan);
  UNARY_FUNC_TEST(testCosh, cosh);
  UNARY_FUNC_TEST(testSinh, sinh);
  UNARY_FUNC_TEST(testTanh, tanh);
  UNARY_FUNC_TEST(testAbs, abs);
  UNARY_FUNC_TEST(testFAbs, fabs);

  UNARY_ASSIGNOP_TEST(testPlusEquals, +=);
  UNARY_ASSIGNOP_TEST(testMinusEquals, -=);
  UNARY_ASSIGNOP_TEST(testTimesEquals, *=);
  UNARY_ASSIGNOP_TEST(testDivideEquals, /=);

  void testMax();
  void testMin();

  template <typename ScalarT>
  ScalarT composite1(const ScalarT& a, const ScalarT& b) {
    ScalarT t1 = 3. * a + sin(b) / log(fabs(a - b * 7.));
    ScalarT t2 = 1.0e3;
    ScalarT t3 = 5.7e4;
    ScalarT t4 = 3.2e5;
    t1 *= cos(a + exp(t1)) / 6. - tan(t1*sqrt(abs(a * log10(abs(b)))));
    t1 -= acos((6.+asin(pow(fabs(a),b)/t2))/t3) * asin(pow(fabs(b),2.)*1.0/t4) * atan((b*pow(2.,log(abs(a))))/(t3*t4));
    t1 /= cosh(b - 0.7) + 7.*sinh(t1 + 0.8)*tanh(9./a) - 9.;
    t1 += pow(abs(a*4.),b-8.)/cos(a*b*a);
    
  return t1;
}

  void testComposite1() {
    c_sfad = composite1(a_sfad, b_sfad);
    c_fad = composite1(a_fad, b_fad);
    compareFads(c_sfad, c_fad);
  }

  void testPlusLR() {
    SFadType aa_sfad = a_sfad;
    FAD::Fad<double> aa_fad = a_fad;
    aa_sfad = 1.0;
    aa_fad = 1.0;
    aa_sfad = aa_sfad + b_sfad;
    aa_fad = aa_fad + b_fad;
    compareFads(aa_sfad, aa_fad);
  }

  void testMinusLR() {
    SFadType aa_sfad = a_sfad;
    FAD::Fad<double> aa_fad = a_fad;
    aa_sfad = 1.0;
    aa_fad = 1.0;
    aa_sfad = aa_sfad - b_sfad;
    aa_fad = aa_fad - b_fad;
    compareFads(aa_sfad, aa_fad);
  }

  void testTimesLR() {
    SFadType aa_sfad = a_sfad;
    FAD::Fad<double> aa_fad = a_fad;
    aa_sfad = 2.0;
    aa_fad = 2.0;
    aa_sfad = aa_sfad * b_sfad;
    aa_fad = aa_fad * b_fad;
    compareFads(aa_sfad, aa_fad);
  }

  void testDivideLR() {
    SFadType aa_sfad = a_sfad;
    FAD::Fad<double> aa_fad = a_fad;
    aa_sfad = 2.0;
    aa_fad = 2.0;
    aa_sfad = aa_sfad / b_sfad;
    aa_fad = aa_fad / b_fad;
    compareFads(aa_sfad, aa_fad);
  }

protected:

  // SFad variables
  SFadType a_sfad, b_sfad, c_sfad;

  // Fad variables
  FAD::Fad<double> a_fad, b_fad, c_fad;

  // Random number generator
  Sacado::Random urand;

  // Number of derivative components
  int n;

  // Tolerances to which fad objects should be the same
  double tol_a, tol_r;

}; // class SFadOpsUnitTest

#endif // SFADUNITTESTS_HPP

---