Functor.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2015 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

/*
 * Functor classes used by SeparableXYTransform.
 */

#ifndef LSST_AFW_GEOM_FUNCTOR_H
#define LSST_AFW_GEOM_FUNCTOR_H

#include <string>
#include <memory>
#include "lsst/base.h"
#include "lsst/daf/base.h"

namespace lsst {
namespace afw {
namespace geom {

class Functor : public daf::base::Citizen {
public:
    explicit Functor(std::string const& name);

    Functor(Functor const &);
    Functor(Functor &&);
    Functor &operator=(Functor const &);
    Functor &operator=(Functor &&);

    virtual ~Functor() = default;

    virtual std::shared_ptr<Functor> clone() const = 0;

    virtual double operator()(double x) const = 0;

    virtual double inverse(double y, double tol = 1e-10, unsigned int maxiter = 1000) const;

    virtual double derivative(double x) const = 0;

private:
    std::string _name;
};

class LinearFunctor : public Functor {
public:
    LinearFunctor(double slope, double intercept);

    LinearFunctor(LinearFunctor const &);
    LinearFunctor(LinearFunctor &&);
    LinearFunctor &operator=(LinearFunctor const &);
    LinearFunctor &operator=(LinearFunctor &&);

    ~LinearFunctor() = default;

    virtual std::shared_ptr<Functor> clone() const;

    virtual double operator()(double x) const;

    virtual double derivative(double x) const;

private:
    double _slope;
    double _intercept;
};

}  // namespace geom
}  // namespace af
}  // namespace lsst

#endif  // LSST_AFW_GEOM_FUNCTOR_H