include/ewalena/lac/solver_control.h

Go to the documentation of this file.

// -------------------------------------------------------------------
// @author Toby D. Young
// @version $Id: solver_control.h 987 2012-11-26 15:16:27Z oneliefleft $
//
// Copyright 2012 namespace ewalena authors. 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.
//
// THIS SOFTWARE IS PROVIDED BY THE NAMEPSACE EWALENA AUTHORS ``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
// NAMESPACE EWALENA AUTHORS 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.
//
// The views and conclusions contained in the software and
// documentation are those of the authors and should not be
// interpreted as representing official policies, either expressed or
// implied, of the namespace ewalena authors.
// -------------------------------------------------------------------

#ifndef __ewalena_solver_control_h
#define __ewalena_solver_control_h

#ifdef EWALENA_HAVE_CONFIG_H
#include <ewalena/base/config.h>
#endif

#include <cassert>

namespace ewalena 
{

  template <typename ValueType = double>
    class SolverControl
    {

    public:

    SolverControl (const unsigned int max_n_iterations,
                   const double       max_tolerance);
    
    ~SolverControl ();
    
    enum State 
    {
      /* Nothing happening / no change. */
      null = 0,

      /* Solver has converged. */
      pass,

      /* Solver has not converged. */
      fail
    };

    State solver_state ();
    
    State check (const unsigned int n_iterations,
                 const ValueType    tolerance);
    
    unsigned int max_n_iterations () const;

    ValueType max_tolerance () const;
    
    unsigned int n_iterations () const;
    
    ValueType tolerance () const;

    protected:

    unsigned int max_n_iterations_;
    
    unsigned int n_iterations_;
    
    ValueType max_tolerance_;
    
    ValueType tolerance_;
    
    State solver_state_;

    }; /* SolverControl */

} /* namespace ewalena */

#endif /* __ewalena_eigensolver_h */