monitor.h

Go to the documentation of this file.

/*
 *  Copyright 2008-2014 NVIDIA Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
 
#pragma once
 
#include <cusp/detail/config.h>
#include <cusp/blas/blas.h>
#include <cusp/complex.h>
 
#include <limits>
#include <iostream>
#include <iomanip>
 
namespace cusp
{
template <typename ValueType>
class monitor
{
public:
    typedef typename cusp::norm_type<ValueType>::type Real;
 
    template <typename VectorType>
    monitor(const VectorType& b,
            const size_t iteration_limit = 500,
            const Real relative_tolerance = 1e-5,
            const Real absolute_tolerance = 0,
            const bool verbose = false);
 
    void operator++(void);
 
    bool converged(void) const;
 
    Real residual_norm(void) const;
 
    size_t iteration_count(void) const;
 
    size_t iteration_limit(void) const;
 
    Real relative_tolerance(void) const;
 
    Real absolute_tolerance(void) const;
 
    Real tolerance(void) const;
 
    template <typename Vector>
    bool finished(const Vector& r);
 
    template <typename DerivedPolicy, typename Vector>
    bool finished(thrust::execution_policy<DerivedPolicy> &exec, const Vector& r);
 
    void set_verbose(bool verbose_ = true);
 
    bool is_verbose(void);
 
    template <typename Vector>
    void reset(const Vector& b);
 
    void print(void);
 
    Real immediate_rate(void);
 
    Real geometric_rate(void);
 
    Real average_rate(void);
 
    cusp::array1d<Real,cusp::host_memory> residuals;
 
private:
 
    Real b_norm;
    Real r_norm;
    size_t iteration_limit_;
    size_t iteration_count_;
    Real relative_tolerance_;
    Real absolute_tolerance_;
    bool verbose;
};
 
// TODO : Remove convergence, default, and verbose monitors in v0.6.0
 
template <typename ValueType>
class convergence_monitor : public monitor<ValueType>
{
private:
 
    typedef monitor<ValueType> Parent;
 
public:
 
    typedef typename Parent::Real Real;
 
    template <typename VectorType>
    CUSP_DEPRECATED
    convergence_monitor(const VectorType& b,
                        const size_t iteration_limit = 500,
                        const Real relative_tolerance = 1e-5,
                        const Real absolute_tolerance = 0)
    : Parent(b, iteration_limit, relative_tolerance, absolute_tolerance, false) {}
};
 
template <typename ValueType>
class default_monitor : public monitor<ValueType>
{
private:
 
    typedef monitor<ValueType> Parent;
 
public:
 
    typedef typename Parent::Real Real;
 
    template <typename VectorType>
    CUSP_DEPRECATED
    default_monitor(const VectorType& b,
                    const size_t iteration_limit = 500,
                    const Real relative_tolerance = 1e-5,
                    const Real absolute_tolerance = 0)
    : Parent(b, iteration_limit, relative_tolerance, absolute_tolerance, false) {}
};
 
template <typename ValueType>
class verbose_monitor : public monitor<ValueType>
{
private:
 
    typedef monitor<ValueType> Parent;
 
public:
 
    typedef typename Parent::Real Real;
 
    template <typename VectorType>
    CUSP_DEPRECATED
    verbose_monitor(const VectorType& b,
                    const size_t iteration_limit = 500,
                    const Real relative_tolerance = 1e-5,
                    const Real absolute_tolerance = 0)
    : Parent(b, iteration_limit, relative_tolerance, absolute_tolerance, true) {}
};
 
} // end namespace cusp
 
#include <cusp/detail/monitor.inl>