Function2d.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * 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 GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef LSST_AFW_MATH_POLYNOMIALS_Function2d_h_INCLUDED
#define LSST_AFW_MATH_POLYNOMIALS_Function2d_h_INCLUDED
 
#include "Eigen/Core"
#include "lsst/geom/polynomials/SafeSum.h"
#include "lsst/geom/polynomials/ScaledBasis2d.h"
 
namespace lsst { namespace geom { namespace polynomials {

template <typename Basis_>
class Function2d {
public:
 
    using iterator = double *;
    using const_iterator = double const *;

    using Basis = Basis_;

    using Workspace = typename Basis::Workspace;

    explicit Function2d(Basis const & basis) :
        _basis(basis),
        _coefficients(Eigen::VectorXd::Zero(basis.size()))
    {}

    explicit Function2d(Basis const & basis, Eigen::VectorXd const & coefficients) :
        _basis(basis),
        _coefficients(coefficients)
    {
        assert(basis.size() == static_cast<std::size_t>(_coefficients.size()));
    }

    template <typename Iterator>
    explicit Function2d(Basis const & basis, Iterator first, Iterator last) :
        _basis(basis),
        _coefficients(basis.size())
    {
        assert(std::distance(first, last) == static_cast<std::ptrdiff_t>(basis.size()));
        std::copy(first, last, &_coefficients[0]);
    }

    Function2d(Function2d const &) = default;

    Function2d(Function2d &&) = default;

    Function2d & operator=(Function2d const &) = default;

    Function2d & operator=(Function2d &&) = default;


    iterator begin() { return _coefficients.data(); }
    iterator end() { return begin() + size(); }
    const_iterator cbegin() const { return _coefficients.data(); }
    const_iterator cend() const { return begin() + size(); }
    const_iterator begin() const { return _coefficients.data(); }
    const_iterator end() const { return begin() + size(); }

    Basis const & getBasis() const { return _basis; }

    std::size_t size() const { return _basis.size(); }

    Workspace makeWorkspace() const { return _basis.makeWorkspace(); }

    double operator()(geom::Point2D const & point, SumMode mode=SumMode::FAST) const {
        return _basis.sumWith(point, _coefficients, mode);
    }

    double operator()(geom::Point2D const & point, Workspace & workspace, SumMode mode=SumMode::FAST) const {
        return _basis.sumWith(point, _coefficients, workspace, mode);
    }


    double & operator[](std::size_t n) { return  begin()[n]; }
    double const & operator[](std::size_t n) const { return begin()[n]; }


    auto getCoefficients() {
        // Return a block view to ensure the caller only modify the values, not the size.
        return _coefficients.head(size());
    }
    auto getCoefficients() const { return _coefficients.head(size()); }

    Function2d<typename Basis::Scaled> scaled(Scaling2d const & scaling) const {
        return Function2d<typename Basis::Scaled>(getBasis().scaled(scaling), _coefficients);
    }
 
private:
    Basis _basis;
    Eigen::VectorXd _coefficients;
};

template <typename Basis>
Function2d<Basis> makeFunction2d(Basis const & basis, Eigen::VectorXd const & coefficients) {
    return Function2d<Basis>(basis, coefficients);
}

template <typename Basis, typename Iterator>
Function2d<Basis> makeFunction2d(Basis const & basis, Iterator first, Iterator last) {
    return Function2d<Basis>(basis, first, last);
}
 
}}} // namespace lsst::geom::polynomials
 
#endif // !LSST_AFW_MATH_POLYNOMIALS_Function2d_h_INCLUDED