SquarePolynomialVector.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2015, Chris Rogers
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *  3. Neither the name of STFC nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef SquarePolynomialVector_hh
#define SquarePolynomialVector_hh 1
 
#include "Fields/Interpolation/MMatrix.h"
#include "Fields/Interpolation/MVector.h"
#include "Fields/Interpolation/PolynomialCoefficient.h"
 
#include <map>
 
namespace interpolation {
 
    class SquarePolynomialVector {
    public:
        SquarePolynomialVector();
 
        SquarePolynomialVector(const SquarePolynomialVector& pv);
 
        SquarePolynomialVector& operator=(const SquarePolynomialVector&) = default;
 
        SquarePolynomialVector(int pointDimension, MMatrix<double> polynomialCoefficients);
 
        SquarePolynomialVector(std::vector<PolynomialCoefficient> coefficients);
 
        ~SquarePolynomialVector() { ; }
 
        void SetCoefficients(int pointDim, MMatrix<double> coeff);
 
        void SetCoefficients(std::vector<PolynomialCoefficient> coeff);
 
        void SetCoefficients(MMatrix<double> coeff);
 
        MMatrix<double> GetCoefficientsAsMatrix() const { return _polyCoeffs; }
 
        void F(const double* point, double* value) const;
 
        void F(const MVector<double>& point, MVector<double>& value) const;
 
        SquarePolynomialVector Deriv(const int* derivPower) const;
 
        unsigned int PointDimension() const { return _pointDim; }
 
        unsigned int ValueDimension() const { return _polyCoeffs.num_row(); }
 
        unsigned int PolynomialOrder() const;
 
        SquarePolynomialVector* Clone() const { return new SquarePolynomialVector(*this); }
 
        MVector<double>& MakePolyVector(
                const MVector<double>& point, MVector<double>& polyVector) const;
 
        double* MakePolyVector(const double* point, double* polyVector) const;
 
        static std::vector<int> IndexByPower(int index, int nInputVariables);
 
        static std::vector<int> IndexByVector(int index, int nInputVariables);
 
        static unsigned int NumberOfPolynomialCoefficients(int pointDimension, int order);
 
        friend std::ostream& operator<<(std::ostream&, const SquarePolynomialVector&);
 
        static void PrintHeaders(bool willPrintHeaders) { _printHeaders = willPrintHeaders; }
 
        void PrintHeader(
                std::ostream& out, char int_separator = '.', char str_separator = ' ',
                int length = 14, bool pad_at_start = true) const;
 
        template <class Container>
        static void PrintContainer(
                std::ostream& out, const Container& container, char T_separator, char str_separator,
                int length, bool pad_at_start);
 
    private:
        static void IndexByPowerRecursive(
                std::vector<int> check, size_t check_index, size_t poly_power,
                std::vector<std::vector<int> >& nearby_points);
 
        int _pointDim;
        MMatrix<double> _polyCoeffs;
        static std::vector<std::vector<std::vector<int> > > _polyKeyByPower;
        static std::vector<std::vector<std::vector<int> > > _polyKeyByVector;
        static bool _printHeaders;
    };
 
    std::ostream& operator<<(std::ostream&, const SquarePolynomialVector&);
 
}  // namespace interpolation
#endif  // SquarePolynomialVector_hh