imp doc wiki groups imp at salilab.org | contact

UnaryFunction.h

Go to the documentation of this file.

/**
 *  \file UnaryFunction.h    \brief Single variable function.
 *
 *  Copyright 2007-2010 IMP Inventors. All rights reserved.
 */

#ifndef IMP_UNARY_FUNCTION_H
#define IMP_UNARY_FUNCTION_H

#include "kernel_config.h"
#include "base_types.h"
#include "RefCounted.h"
#include "Pointer.h"

IMP_BEGIN_NAMESPACE

//! Abstract single variable functor class for score functions.
/** These functors take a single feature value, and return a corresponding
    score (and optionally also the first derivative).

    Implementers should check out IMP_UNARY_FUNCTION() and
    IMP_UNARY_FUNCTION_INLINE().
 */
class IMPEXPORT UnaryFunction : public Object
{
public:
  UnaryFunction();

  //! Calculate score with respect to the given feature.
  /** \param[in] feature Value of feature being tested.
      \return Score
   */
  virtual double evaluate(double feature) const=0;

  //! Calculate score and derivative with respect to the given feature.
  /** \param[in] feature Value of feature being tested.
      \return a FloatPair containing the score and its partial derivative
              with respect to the given feaure.
   */
  virtual DerivativePair evaluate_with_derivative(double feature) const = 0;

  IMP_REF_COUNTED_DESTRUCTOR(UnaryFunction);
};

IMP_OBJECTS(UnaryFunction);

IMP_END_NAMESPACE

#endif  /* IMP_UNARY_FUNCTION_H */

---