Teuchos_XMLPerfTestArchive.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_XMLPERFTESTARCHIVE_HPP
#define TEUCHOS_XMLPERFTESTARCHIVE_HPP


#include <Teuchos_ConfigDefs.hpp>
#include <Teuchos_FileInputSource.hpp>
#include <Teuchos_XMLObject.hpp>
#include <sstream>

//----------------------------------------------------------------------------
//-------- Identify Compiler Version -----------------------------------------
//----------------------------------------------------------------------------

#if defined __ECC || defined __ICC || defined __INTEL_COMPILER
  #define TEUCHOS_COMPILER_NAME "Intel C++"
  #if defined __ICC
    #define TEUCHOS_COMPILER_VERSION __ICC
  #else
    #if defined __INTEL_COMPILER
      #define TEUCHOS_COMPILER_VERSION __INTEL_COMPILER
    #else
      #define TEUCHOS_COMPILER_VERSION __ECC
    #endif
  #endif
  #define TEUCHOS_COMPILER_INTEL 1
#endif

#if defined __IBMC__ || defined __IBMCPP__
  #define TEUCHOS_COMPILER_NAME "IBM C++"
  #if defined __IBMC__
    #define TEUCHOS_COMPILER_VERSION __IBMC__
  #else
    #define TEUCHOS_COMPILER_VERSION __IBMCPP__
  #endif
  #define TEUCHOS_COMPILER_IBM 1
#endif

#if defined __APPLE_CC__
   /* Apple uses GNU as compiler */
  #define TEUCHOS_COMPILER_APPLECC 1
#endif

#if defined __clang__
  #define TEUCHOS_COMPILER_NAME "Clang"
  #define TEUCHOS_COMPILER_VERSION __clang_major__*100+__clang_minor__*10+__clang_patchlevel__
  #define TEUCHOS_COMPILER_CLANG 1
#endif

#if defined __GNUC__ && !defined TEUCHOS_COMPILER_NAME && !defined __clang__
  #define TEUCHOS_COMPILER_NAME "Gnu GCC"
  #define TEUCHOS_COMPILER_VERSION __GNUC__*100+__GNUC_MINOR__*10+__GNUC_PATCHLEVEL__
  #define TEUCHOS_COMPILER_GCC 1
#endif

#if defined __PGIC__ && !defined TEUCHOS_COMPILER_NAME
  #define TEUCHOS_COMPILER_NAME "PGI C++"
  #define TEUCHOS_COMPILER_VERSION __PGIC__*100+__PGIC_MINOR__*10+__PGIC_PATCHLEVEL__
  #define TEUCHOS_COMPILER_PGI 1
#endif

#if defined __NVCC__
  #define TEUCHOS_DEVICE_COMPILER_NAME "NVIDIA NVCC"
  #define TEUCHOS_DEVICE_COMPILER_VERSION __NVCC__
#endif

#if !defined TEUCHOS_COMPILER_NAME
  #define TEUCHOS_COMPILER_NAME "Unknown compiler"
#endif

#if !defined TEUCHOS_COMPILER_VERSION
  #define TEUCHOS_COMPILER_VERSION 0
#endif

#if !defined TEUCHOS_DEVICE_COMPILER_NAME
  #define TEUCHOS_DEVICE_COMPILER_NAME TEUCHOS_COMPILER_NAME
#endif

#if !defined TEUCHOS_DEVICE_COMPILER_VERSION
  #define TEUCHOS_DEVICE_COMPILER_VERSION TEUCHOS_COMPILER_VERSION
#endif

namespace Teuchos {
struct ValueTolerance {
  double value;
  double lower;
  double upper;
  double tolerance;
  bool use_tolerance;

  ValueTolerance();
  ValueTolerance(double val, double tol);
  ValueTolerance(double val, double low, double up);

  ValueTolerance(std::string str);

  bool operator ==(ValueTolerance& rhs);

  std::string as_string();
  void from_string(const std::string& valtol_str);
};


class XMLTestNode : public XMLObject {
public:
  XMLTestNode();
  XMLTestNode(const std::string &tag);
  XMLTestNode(XMLObjectImplem *ptr);
  XMLTestNode(XMLObject obj);
  void addDouble (const std::string& name, double val);
  void addInt (const std::string& name, int val);
  void addBool (const std::string& name, bool val);
  void addValueTolerance(const std::string& name, ValueTolerance val);
  void addString (const std::string& name, std::string val);

  template<class T>
  void addAttribute (const std::string& name, T val) {
    for (size_t i = 0; i < name.length (); i++) {
      if (name[i] == ' ') {
        return;
      }
    }
    std::ostringstream strs;
    strs << val;
    XMLTestNode entry (name);
    entry.addContent (strs.str ());
    XMLObject::addChild (entry);
  }

  bool hasChild(const std::string &name) const;

  void appendContentLine(const size_t& i, const std::string &str);

  XMLTestNode getChild(const std::string &name) const;

  XMLTestNode getChild(const int &i) const;

  const XMLObject* xml_object() const;

  bool hasSameElements(XMLTestNode const & lhs) const;
};

XMLTestNode PerfTest_MachineConfig();

enum PerfTestResult {PerfTestFailed, PerfTestPassed,
                     PerfTestNewMachine, PerfTestNewConfiguration,
                     PerfTestNewTest, PerfTestNewTestConfiguration,
                     PerfTestUpdatedTest};

PerfTestResult
PerfTest_CheckOrAdd_Test (XMLTestNode machine_config,
                          XMLTestNode new_test,
                          const std::string filename,
                          const std::string ext_hostname = std::string ());

} // namespace Teuchos

#endif