IMP::example::ExampleUnaryFunction Class Reference

---

Detailed Description

A simple unary function.

This one happens to be a harmonic. The source code is as follows:

/**
 *  \file example/ExampleUnaryFunction.h
 *  \brief A simple unary function.
 *
 *  Copyright 2007-2010 IMP Inventors. All rights reserved.
 *
 */


#ifndef IMPEXAMPLE_EXAMPLE_UNARY_FUNCTION_H
#define IMPEXAMPLE_EXAMPLE_UNARY_FUNCTION_H

#include "example_config.h"
#include <IMP/UnaryFunction.h>
#include <IMP/utility.h>

IMPEXAMPLE_BEGIN_NAMESPACE

//! A simple unary function
/** This one happens to be a harmonic.
    The source code is as follows:
    \include ExampleUnaryFunction.h

    \note The class does not have an IMPEXAMPLEEXPORT
    since it is all defined in a header.
 */
class ExampleUnaryFunction : public UnaryFunction
{
  Float center_;
  Float k_;
public:
  /** Create with the given center and spring constant. While it
      is generally bad form to have two Float arguments, it is
      hard to avoid here, and there is a bit of a sanity check.*/
  ExampleUnaryFunction(Float center, Float k) : center_(center), k_(k) {
    IMP_USAGE_CHECK(k > 0, "The spring constant must be positive.");
  }

  IMP_UNARY_FUNCTION_INLINE(ExampleUnaryFunction,
                            .5*k_*square(feature-center_),
                            k_*(feature - center_),
                            "Harmonic: " << center_ << " and " << k_
                            << std::endl);
};

IMPEXAMPLE_END_NAMESPACE

#endif  /* IMPEXAMPLE_EXAMPLE_UNARY_FUNCTION_H */

Note:

The class does not have an IMPEXAMPLEEXPORT since it is all defined in a header.

Inheritance diagram for IMP::example::ExampleUnaryFunction:

[legend]

Public Member Functions
virtual double	evaluate (double feature) const
virtual DerivativePair	evaluate_with_derivative (double feature) const
	ExampleUnaryFunction (Float center, Float k)
virtual std::string	get_type_name () const
virtual ::IMP::VersionInfo	get_version_info () const

---

Constructor & Destructor Documentation

IMP::example::ExampleUnaryFunction::ExampleUnaryFunction	(	Float	center,
		Float	k
	)

Create with the given center and spring constant. While it is generally bad form to have two Float arguments, it is hard to avoid here, and there is a bit of a sanity check.

---

The documentation for this class was generated from the following files:

• ExampleUnaryFunction.h
• example/__init__.py