RecursionRelation.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2018, Martin Duy Tat
 *  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 RECURSION_RELATION_H
#define RECURSION_RELATION_H

#include "DifferentialOperator.h"
#include "Polynomial.h"

namespace polynomial {

class RecursionRelation {
public:
    RecursionRelation();
    RecursionRelation(const std::size_t &power,
                      const std::size_t &highestXorder);
    RecursionRelation(const RecursionRelation &doperator);
    ~RecursionRelation();
    RecursionRelation& operator= (const RecursionRelation &recursion);
    void printOperator() const;
    void truncate(std::size_t highestXorder);
    void applyOperator();
    void differentiateX();
    std::size_t getMaxXDerivatives() const;
    std::size_t getMaxSDerivatives() const;
    double evaluatePolynomial(const double &x,
                              const std::size_t &xDerivative,
                              const std::size_t &sDerivative) const;
    bool isPolynomialZero(const std::size_t &x, const std::size_t &s) const;
    void resizeX(const std::size_t &xDerivatives);
    void resizeS(const std::size_t &sDerivatives);
private:
    DifferentialOperator operator_m;
    std::size_t power_m;
    std::size_t highestXorder_m;
};

inline
    void RecursionRelation::printOperator() const {
        operator_m.printOperator();
}
inline
    void RecursionRelation::differentiateX() {
        operator_m.differentiateX();
}
inline
    std::size_t RecursionRelation::getMaxXDerivatives() const {
        return operator_m.getXDerivatives();
}
inline
    std::size_t RecursionRelation::getMaxSDerivatives() const {
        return operator_m.getSDerivatives();
}
inline
    double RecursionRelation::evaluatePolynomial(
                              const double &x,
                              const std::size_t &xDerivative,
                              const std::size_t &sDerivative) const {
        return operator_m.evaluatePolynomial(x, xDerivative, sDerivative);
}
inline
    bool RecursionRelation::isPolynomialZero(const std::size_t &x,
                                             const std::size_t &s) const {
        return operator_m.isPolynomialZero(x, s);
}
inline
    void RecursionRelation::resizeX(const std::size_t &xDerivatives) {
        operator_m.resizeX(xDerivatives);
}
inline
    void RecursionRelation::resizeS(const std::size_t &sDerivatives) {
        operator_m.resizeS(sDerivatives);
}

}

#endif