Testable.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------

 * GTSAM Copyright 2010, Georgia Tech Research Corporation, 
 * Atlanta, Georgia 30332-0415
 * All Rights Reserved
 * Authors: Frank Dellaert, et al. (see THANKS for the full author list)

 * See LICENSE for the license information

 * -------------------------------------------------------------------------- */

// \callgraph

#pragma once

#include <boost/shared_ptr.hpp>
#include <stdio.h>
#include <string>

#define GTSAM_PRINT(x)((x).print(#x))

namespace gtsam {

  template <class T>
  class TestableConcept {
    static bool checkTestableConcept(const T& d) {
      // check print function, with optional string
      d.print(std::string());
      d.print();

      // check print, with optional threshold
      double tol = 1.0;
      bool r1 = d.equals(d, tol);
      bool r2 = d.equals(d);
      return r1 && r2;
    }
  };

  template<class T>
  inline void print(const T& object, const std::string& s = "") {
    object.print(s);
  }

  template<class T>
  inline bool equal(const T& obj1, const T& obj2, double tol) {
    return obj1.equals(obj2, tol);
  }

  template<class T>
  inline bool equal(const T& obj1, const T& obj2) {
    return obj1.equals(obj2);
  }

  template<class V>
  bool assert_equal(const V& expected, const V& actual, double tol = 1e-9) {
    if (actual.equals(expected, tol))
      return true;
    printf("Not equal:\n");
    expected.print("expected:\n");
    actual.print("actual:\n");
    return false;
  }

  template<class V>
  struct equals : public std::binary_function<const V&, const V&, bool> {
    double tol_;
    equals(double tol = 1e-9) : tol_(tol) {}
    bool operator()(const V& expected, const V& actual) {
      return (actual.equals(expected, tol_));
    }
  };

  template<class V>
  struct equals_star : public std::binary_function<const boost::shared_ptr<V>&, const boost::shared_ptr<V>&, bool> {
    double tol_;
    equals_star(double tol = 1e-9) : tol_(tol) {}
    bool operator()(const boost::shared_ptr<V>& expected, const boost::shared_ptr<V>& actual) {
      if (!actual || !expected) return false;
      return (actual->equals(*expected, tol_));
    }
  };

} // \namespace gtsam

#define GTSAM_CONCEPT_TESTABLE_INST(T) template class gtsam::TestableConcept<T>;
#define GTSAM_CONCEPT_TESTABLE_TYPE(T) typedef gtsam::TestableConcept<T> _gtsam_TestableConcept_##T;