cooling_schedule.h

Go to the documentation of this file.

// Pallas Solver
// Copyright 2015. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * 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.
//
// 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.
//
// Author: ryan.latture@gmail.com (Ryan Latture)

#ifndef PALLAS_COOLING_SCHEDULE_H
#define PALLAS_COOLING_SCHEDULE_H

#include "pallas/types.h"
#include "pallas/internal/state.h"
#include "pallas/step_function.h"


namespace pallas {

    class CoolingSchedule {
    public:
        struct Options {
            Options() {
                type = BOLTZMANN;
                initial_temperature = -1.0;
                final_temperature = 1.0e-12;
                boltzmann_constant = 1.0;
                fast_quench_param = 1.0;
                fast_m_param = 1.0;
                fast_n_param = 1.0;
            }

            CoolingScheduleType type;
            double initial_temperature;
            double final_temperature;
            double boltzmann_constant;
            double fast_quench_param;
            double fast_m_param;
            double fast_n_param;
        };

        static CoolingSchedule* Create(const Options& options);

        virtual ~CoolingSchedule() {};

        virtual void update_temperature() = 0;

        double get_temperature() const;
        double get_initial_temperature() const;

        void set_temperature(double T);

        void calc_start_temperature(const GradientProblem& problem,
                                    internal::State& state,
                                    StepFunction* step_function);


    protected:
        double temperature;
        double initial_temperature;
        double boltzmann_constant;
    };

    class FastCooling : public CoolingSchedule {
    public:
        FastCooling(const CoolingSchedule::Options& options);

        void update_temperature();

    private:
        double fast_m_param;
        double fast_n_param;
        double fast_c_param;
        double fast_quench_param;
    };

    class CauchyCooling : public CoolingSchedule {
    public:
        CauchyCooling(const CoolingSchedule::Options& options);

        void update_temperature();
    };

    class BoltzmannCooling : public CoolingSchedule {
    public:
        BoltzmannCooling(const CoolingSchedule::Options& options);

        void update_temperature();
    };

} // namespace pallas

#endif // PALLAS_COOLING_SCHEDULE_H