Regularizer.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright (C) 2014-2018 Allan Leal
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
// C++ includes
#include <memory>
 
// Reaktoro includes
#include <Reaktoro/Math/Matrix.hpp>
 
namespace Reaktoro {
 
struct OptimumOptions;
struct OptimumProblem;
struct OptimumState;
 
struct RegularizerOptions
{
    bool echelonize = true;
 
    unsigned max_denominator = 0;
};
 
class Regularizer
{
public:
    Regularizer();
 
    Regularizer(const Regularizer& other);
 
    virtual ~Regularizer();
 
    auto operator=(Regularizer other) -> Regularizer&;
 
    auto setOptions(const RegularizerOptions& options) -> void;
 
    auto regularize(OptimumProblem& problem, OptimumState& state, OptimumOptions& options) -> void;
 
    auto regularize(Vector& dgdp, Vector& dbdp) -> void;
 
    auto recover(OptimumState& state) -> void;
 
    auto recover(Vector& dxdp) -> void;
 
private:
    struct Impl;
 
    std::unique_ptr<Impl> pimpl;
};
 
} // namespace Reaktoro