observers.hpp

Go to the documentation of this file.

//This file is part of Bertini 2.
//
//trackers/observers.hpp 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.
//
//trackers/observers.hpp 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 trackers/observers.hpp.  If not, see <http://www.gnu.org/licenses/>.
//
// Copyright(C) Bertini2 Development Team
//
// See <http://www.gnu.org/licenses/> for a copy of the license,
// as well as COPYING.  Bertini2 is provided with permitted
// additional terms in the b2/licenses/ directory.

 
#pragma once
 
#include "bertini2/trackers/events.hpp"
 
#include "bertini2/detail/observer.hpp"
 
#include "bertini2/trackers/base_tracker.hpp"
#include "bertini2/logging.hpp"
#include <boost/type_index.hpp>
 
namespace bertini {
 
    namespace tracking{
 

        // Reset on Initializing, never on TrackingStarted, and never unsubscribe: a reset at
        // TrackingStarted comes after the refinement and misses its increases, and an observer
        // that unsubscribes reports one track forever after (#378).
        template<class TrackerT>
        class FirstPrecisionRecorder
            : public TypedObserver< FirstPrecisionRecorder<TrackerT>, TrackerT,
                    Initializing<typename TrackerTraits<TrackerT>::EventEmitterType,
                                 typename TrackerTraits<TrackerT>::BaseComplexT>,
                    TrackingStarted<typename TrackerTraits<TrackerT>::EventEmitterType>,
                    PrecisionChanged<typename TrackerTraits<TrackerT>::EventEmitterType> >
        { BOOST_TYPE_INDEX_REGISTER_CLASS
 
            using EmitterT = typename TrackerTraits<TrackerT>::EventEmitterType;
            using BCT = typename TrackerTraits<TrackerT>::BaseComplexT;
 
        public:

            ObserveResult OnEvent(Initializing<EmitterT, BCT> const&)
            {
                have_start_ = false;
                precision_increased_ = false;
                starting_precision_ = 0;
                next_precision_ = 0;
                time_of_first_increase_ = typename TrackerTraits<TrackerT>::BaseComplexT{};
                return ObserveResult::KeepObserving;
            }

            ObserveResult OnEvent(TrackingStarted<EmitterT> const& e)
            {
                if (!have_start_)
                {
                    starting_precision_ = e.Get().CurrentPrecision();
                    have_start_ = true;
                }
                return ObserveResult::KeepObserving;
            }

            ObserveResult OnEvent(PrecisionChanged<EmitterT> const& e)
            {
                if (!have_start_)
                {
                    starting_precision_ = e.Previous();
                    have_start_ = true;
                }
                if (!precision_increased_ && e.Next() > e.Previous())
                {
                    precision_increased_ = true;
                    next_precision_ = e.Next();
                    time_of_first_increase_ = e.Get().CurrentTime();
                }
                return ObserveResult::KeepObserving;
            }

            unsigned  StartPrecision() const
            {
                return starting_precision_;
            }

            unsigned NextPrecision() const
            {
                return next_precision_;
            }

            bool DidPrecisionIncrease() const
            {
                return precision_increased_;
            }

            typename TrackerTraits<TrackerT>::BaseComplexT TimeOfIncrease() const
            {
                return time_of_first_increase_;
            }
 
            virtual ~FirstPrecisionRecorder() = default;
 
        private:
 
            bool have_start_ = false;          
            unsigned starting_precision_ = 0;  
            unsigned next_precision_ = 0;      
            bool precision_increased_ = false; 
            typename TrackerTraits<TrackerT>::BaseComplexT time_of_first_increase_{};  
        };
 

        template<class TrackerT>
        class MinMaxPrecisionRecorder
            : public TypedObserver< MinMaxPrecisionRecorder<TrackerT>, TrackerT,
                    Initializing<typename TrackerTraits<TrackerT>::EventEmitterType,
                                 typename TrackerTraits<TrackerT>::BaseComplexT>,
                    TrackingStarted<typename TrackerTraits<TrackerT>::EventEmitterType>,
                    PrecisionChanged<typename TrackerTraits<TrackerT>::EventEmitterType> >
        { BOOST_TYPE_INDEX_REGISTER_CLASS
 
            using EmitterT = typename TrackerTraits<TrackerT>::EventEmitterType;
            using BCT = typename TrackerTraits<TrackerT>::BaseComplexT;
 
            void Include(unsigned p)
            {
                if (p < min_precision_)
                    min_precision_ = p;
                if (p > max_precision_)
                    max_precision_ = p;
            }
 
        public:

            ObserveResult OnEvent(Initializing<EmitterT, BCT> const&)
            {
                min_precision_ = std::numeric_limits<unsigned>::max();
                max_precision_ = 0;
                return ObserveResult::KeepObserving;
            }

            ObserveResult OnEvent(TrackingStarted<EmitterT> const& e)
            {
                Include(e.Get().CurrentPrecision());
                return ObserveResult::KeepObserving;
            }

            ObserveResult OnEvent(PrecisionChanged<EmitterT> const& e)
            {
                Include(e.Previous());
                Include(e.Next());
                return ObserveResult::KeepObserving;
            }

            unsigned MinPrecision() const
            {
                return min_precision_;
            }

            unsigned MaxPrecision() const
            {
                return max_precision_;
            }

            void MinPrecision(unsigned m)
            { min_precision_ = m;}

            void MaxPrecision(unsigned m)
            { max_precision_ = m;}
 
            virtual ~MinMaxPrecisionRecorder() = default;
 
        private:
 
            unsigned min_precision_ = std::numeric_limits<unsigned>::max();
            unsigned max_precision_ = 0;
        };
 

        // A per-track recorder starts afresh at every endgame sub-track, so a precision raised in
        // an earlier sub-track and lowered before the last would go unreported (#378).
        template<class TrackerT>
        class PathPrecisionRecorder
            : public TypedObserver< PathPrecisionRecorder<TrackerT>, TrackerT,
                    TrackingStarted<typename TrackerTraits<TrackerT>::EventEmitterType>,
                    PrecisionChanged<typename TrackerTraits<TrackerT>::EventEmitterType> >
        { BOOST_TYPE_INDEX_REGISTER_CLASS
 
            using EmitterT = typename TrackerTraits<TrackerT>::EventEmitterType;
 
            void Include(unsigned p)
            {
                if (p < min_precision_)
                    min_precision_ = p;
                if (p > max_precision_)
                    max_precision_ = p;
            }
 
        public:

            void Reset()
            {
                precision_increased_ = false;
                time_of_first_increase_ = typename TrackerTraits<TrackerT>::BaseComplexT{};
                min_precision_ = std::numeric_limits<unsigned>::max();
                max_precision_ = 0;
            }

            ObserveResult OnEvent(TrackingStarted<EmitterT> const& e)
            {
                Include(e.Get().CurrentPrecision());
                return ObserveResult::KeepObserving;
            }

            ObserveResult OnEvent(PrecisionChanged<EmitterT> const& e)
            {
                Include(e.Previous());
                Include(e.Next());
                if (!precision_increased_ && e.Next() > e.Previous())
                {
                    precision_increased_ = true;
                    time_of_first_increase_ = e.Get().CurrentTime();
                }
                return ObserveResult::KeepObserving;
            }

            bool DidPrecisionIncrease() const { return precision_increased_; }

            typename TrackerTraits<TrackerT>::BaseComplexT TimeOfIncrease() const { return time_of_first_increase_; }

            unsigned MinPrecision() const { return min_precision_; }

            unsigned MaxPrecision() const { return max_precision_; }
 
            virtual ~PathPrecisionRecorder() = default;
 
        private:
 
            bool precision_increased_ = false;  
            typename TrackerTraits<TrackerT>::BaseComplexT time_of_first_increase_{};  
            unsigned min_precision_ = std::numeric_limits<unsigned>::max();  
            unsigned max_precision_ = 0;  
        };
 

        template<class TrackerT>
        class PrecisionAccumulator : public Observer<TrackerT>
        { BOOST_TYPE_INDEX_REGISTER_CLASS
 
            using EmitterT = typename TrackerTraits<TrackerT>::EventEmitterType;
 
            virtual ObserveResult Observe(AnyEvent const& e) override
            {
                const TrackingEvent<EmitterT>* p = dynamic_cast<const TrackingEvent<EmitterT>*>(&e);
                if (p)
                {
                    precisions_.push_back(p->Get().CurrentPrecision());
                }
                return ObserveResult::KeepObserving;
            }
 
 
        public:
            const std::vector<unsigned>& Precisions() const
            {
                return precisions_;
            }
 
            virtual ~PrecisionAccumulator() = default;
 
        private:
            std::vector<unsigned> precisions_;
        };

        template<class TrackerT, template<class> class EventT = SuccessfulStep>
        class AMPPathAccumulator
            : public TypedObserver< AMPPathAccumulator<TrackerT,EventT>, TrackerT,
                    EventT<typename TrackerTraits<TrackerT>::EventEmitterType> >
        { BOOST_TYPE_INDEX_REGISTER_CLASS
 
            using EmitterT = typename TrackerTraits<TrackerT>::EventEmitterType;
 
        public:

            ObserveResult OnEvent(EventT<EmitterT> const& e)
            {
                path_.push_back(e.Get().CurrentPoint());
                return ObserveResult::KeepObserving;
            }

            const std::vector<Vec<complex_mp> >& Path() const
            {
                return path_;
            }
 
            virtual ~AMPPathAccumulator() = default;
 
        private:
            std::vector<Vec<complex_mp> > path_;
        };
 
 

        template<class TrackerT>
        class GoryDetailLogger : public Observer<TrackerT>
        { BOOST_TYPE_INDEX_REGISTER_CLASS
        public:
 
            using EmitterT = typename TrackerTraits<TrackerT>::EventEmitterType;  
 
            virtual ~GoryDetailLogger() = default;

            virtual ObserveResult Observe(AnyEvent const& e) override
            {
 
 
                if (auto p = dynamic_cast<const Initializing<EmitterT,complex_dbl>*>(&e))
                {
                    // digits to print come from the VALUES being printed -- not from the ambient
                    // default, which need not be the precision anything here was computed at, and
                    // not from the System, which no longer carries one (ADR-0057)
                    BOOST_LOG_TRIVIAL(severity_level::debug) << std::setprecision(static_cast<int>(DoublePrecision()))
                        << "initializing in double, tracking path\nfrom\tt = "
                        << p->StartTime() << "\nto\tt = " << p->EndTime()
                        << "\n from\tx = \n" << p->StartPoint()
                        << "\n tracking system " << p->Get().GetSystem() << "\n\n";
                }
                else if (auto p = dynamic_cast<const Initializing<EmitterT,complex_mp>*>(&e))
                {
                    // ditto: ask the point being logged
                    BOOST_LOG_TRIVIAL(severity_level::debug) << std::setprecision(static_cast<int>(Precision(p->StartPoint())))
                         << "initializing in multiprecision, tracking path\nfrom\tt = " << p->StartTime() << "\nto\tt = " << p->EndTime() << "\n from\tx = \n" << p->StartPoint()
                        << "\n tracking system " << p->Get().GetSystem() << "\n\n";
                }
 
                else if(auto p = dynamic_cast<const TrackingEnded<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "tracking ended";
 
                else if (auto p = dynamic_cast<const NewStep<EmitterT>*>(&e))
                {
                    auto& t = p->Get();
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "Tracker iteration " << t.NumTotalStepsTaken() << "\ncurrent precision: " << t.CurrentPrecision();
 
 
                    BOOST_LOG_TRIVIAL(severity_level::trace) << std::setprecision(static_cast<int>(t.CurrentPrecision()))
                        << "t = " << t.CurrentTime()
                        << "\ncurrent stepsize: " << t.CurrentStepsize()
                        << "\ndelta_t = " << t.DeltaT()
                        << "\ncurrent x size = " << t.CurrentPoint().size()
                        << "\ncurrent x = " << t.CurrentPoint();
                }
 
 
 
                else if (auto p = dynamic_cast<const SingularStartPoint<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "singular start point";
                else if (auto p = dynamic_cast<const InfinitePathTruncation<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "tracker iteration indicated going to infinity, truncated path";
 
 
 
 
                else if (auto p = dynamic_cast<const SuccessfulStep<EmitterT>*>(&e))
                {
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "tracker iteration successful\n\n\n";
                }
 
                else if (auto p = dynamic_cast<const FailedStep<EmitterT>*>(&e))
                {
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "tracker iteration unsuccessful\n\n\n";
                }
 
 
 
 
 
 
                else if (auto p = dynamic_cast<const SuccessfulPredict<EmitterT,complex_mp>*>(&e))
                {
                    BOOST_LOG_TRIVIAL(severity_level::trace) << std::setprecision(static_cast<int>(Precision(p->ResultingPoint()))) << "prediction successful (complex_mp), result:\n" << p->ResultingPoint();
                }
                else if (auto p = dynamic_cast<const SuccessfulPredict<EmitterT,complex_dbl>*>(&e))
                {
                    BOOST_LOG_TRIVIAL(severity_level::trace) << std::setprecision(static_cast<int>(Precision(p->ResultingPoint()))) << "prediction successful (complex_dbl), result:\n" << p->ResultingPoint();
                }
 
                else if (auto p = dynamic_cast<const SuccessfulCorrect<EmitterT,complex_mp>*>(&e))
                {
                    BOOST_LOG_TRIVIAL(severity_level::trace) << std::setprecision(static_cast<int>(Precision(p->ResultingPoint()))) << "correction successful (complex_mp), result:\n" << p->ResultingPoint();
                }
                else if (auto p = dynamic_cast<const SuccessfulCorrect<EmitterT,complex_dbl>*>(&e))
                {
                    BOOST_LOG_TRIVIAL(severity_level::trace) << std::setprecision(static_cast<int>(Precision(p->ResultingPoint()))) << "correction successful (complex_dbl), result:\n" << p->ResultingPoint();
                }
 
 
                else if (auto p = dynamic_cast<const PredictorHigherPrecisionNecessary<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "Predictor, higher precision necessary";
                else if (auto p = dynamic_cast<const CorrectorHigherPrecisionNecessary<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "corrector, higher precision necessary";
 
 
 
                else if (auto p = dynamic_cast<const CorrectorMatrixSolveFailure<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "corrector, matrix solve failure or failure to converge";
                else if (auto p = dynamic_cast<const PredictorMatrixSolveFailure<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "predictor, matrix solve failure or failure to converge";
                else if (auto p = dynamic_cast<const FirstStepPredictorMatrixSolveFailure<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::trace) << "Predictor, matrix solve failure in initial solve of prediction";
 
 
                else if (auto p = dynamic_cast<const PrecisionChanged<EmitterT>*>(&e))
                    BOOST_LOG_TRIVIAL(severity_level::debug) << "changing precision from " << p->Previous() << " to " << p->Next();
 
                else
                    BOOST_LOG_TRIVIAL(severity_level::debug) << "unlogged event, of type: " << boost::typeindex::type_id_runtime(e).pretty_name();
 
                return ObserveResult::KeepObserving;
            }
 
        };
 
 

        template<class TrackerT>
        class StepFailScreenPrinter
            : public TypedObserver< StepFailScreenPrinter<TrackerT>, TrackerT,
                    FailedStep<typename TrackerTraits<TrackerT>::EventEmitterType> >
        { BOOST_TYPE_INDEX_REGISTER_CLASS
        public:
 
            using EmitterT = typename TrackerTraits<TrackerT>::EventEmitterType;  

            ObserveResult OnEvent(FailedStep<EmitterT> const& /*e*/)
            {
                std::cout << "observed step failure" << std::endl;
                return ObserveResult::KeepObserving;
            }
 
            virtual ~StepFailScreenPrinter() = default;
        };
 
    } //re: namespace tracking
 
}// re: namespace bertini