Linear.h

Go to the documentation of this file.

/**
 *  \file IMP/core/Linear.h    \brief A linear function.
 *
 *  Copyright 2007-2025 IMP Inventors. All rights reserved.
 */

#ifndef IMPCORE_LINEAR_H
#define IMPCORE_LINEAR_H

#include <IMP/core/core_config.h>
#include <IMP/UnaryFunction.h>
#include <cereal/access.hpp>
#include <cereal/types/base_class.hpp>
#include <cereal/types/polymorphic.hpp>

IMPCORE_BEGIN_NAMESPACE

//! %Linear function
/** \note The offset is not meaningful for optimization, but does
    make the displayed energies nicer.
 */
class Linear : public UnaryFunction {
 public:
  //! Create with the given offset and slope.
  Linear(double offset, double slope) : slope_(slope), offset_(offset) {}
  Linear() {}

  void set_slope(double f) { slope_ = f; }

  double get_slope() const { return slope_; }

  void set_offset(double f) { offset_ = f; }

  double get_offset() const { return offset_; }

  virtual double evaluate(double feature) const override {
    return (feature - offset_) * slope_;
  }

  virtual DerivativePair evaluate_with_derivative(double feature) const
      override {
    return DerivativePair(evaluate(feature), slope_);
  }

  IMP_OBJECT_METHODS(Linear);

 private:
  double slope_, offset_;

  friend class cereal::access;

  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<UnaryFunction>(this),
       slope_, offset_);
  }
  IMP_OBJECT_SERIALIZE_DECL(Linear);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_LINEAR_H */