boost/libs/numeric/odeint/test/adaptive_iterator.cpp

/*
 [auto_generated]
 libs/numeric/odeint/test/adaptive_iterator.cpp

 [begin_description]
 This file tests the adaptive iterators.
 [end_description]

 Copyright 2012-2013 Karsten Ahnert
 Copyright 2012-2013 Mario Mulansky

 Distributed under the Boost Software License, Version 1.0.
 (See accompanying file LICENSE_1_0.txt or
 copy at http://www.boost.org/LICENSE_1_0.txt)
 */


#define BOOST_TEST_MODULE odeint_adaptive_iterator

#include <iterator>
#include <algorithm>
#include <vector>

#include <boost/numeric/odeint/config.hpp>
#include <boost/array.hpp>
#include <boost/range/algorithm/copy.hpp>
#include <boost/range/algorithm/for_each.hpp>
#include <boost/mpl/vector.hpp>

#include <boost/test/unit_test.hpp>
#include <boost/test/floating_point_comparison.hpp>

#include <boost/numeric/odeint/iterator/adaptive_iterator.hpp>
#include "dummy_steppers.hpp"
#include "dummy_odes.hpp"
#include "dummy_observers.hpp"

namespace mpl = boost::mpl;
using namespace boost::numeric::odeint;

typedef dummy_stepper::state_type state_type;
typedef dummy_stepper::value_type value_type;

BOOST_AUTO_TEST_SUITE( adaptive_iterator_test )

typedef mpl::vector<
    dummy_controlled_stepper
    , dummy_dense_output_stepper
    > dummy_steppers;


BOOST_AUTO_TEST_CASE( copy_controlled_stepper_iterator )
{
    typedef adaptive_iterator< dummy_controlled_stepper , empty_system , state_type > iterator_type;

    state_type x = {{ 1.0 }};
    iterator_type iter1( dummy_controlled_stepper() , empty_system() , x );
    iterator_type iter2( iter1 );

    BOOST_CHECK_EQUAL( &( *iter1 ) , &x );
    BOOST_CHECK_EQUAL( &( *iter2 ) , &x );
    BOOST_CHECK_EQUAL( &( *iter1 ) , &( *iter2 ) );
    BOOST_CHECK( iter1.same( iter2 ) );

    ++iter1;
    ++iter2;

    BOOST_CHECK_EQUAL( &( *iter1 ) , &x );
    BOOST_CHECK_EQUAL( &( *iter2 ) , &x );
    BOOST_CHECK_EQUAL( &( *iter1 ) , &( *iter2 ) );
    BOOST_CHECK( iter1.same( iter2 ) );

}

BOOST_AUTO_TEST_CASE( copy_dense_output_stepper_iterator )
{
    typedef adaptive_iterator< dummy_dense_output_stepper , empty_system , state_type > iterator_type;

    state_type x = {{ 1.0 }};
    // fix by mario: do not dereference iterators at the end - made iter1 start iterator
    iterator_type iter1( dummy_dense_output_stepper() , empty_system() , x , 0.0 , 1.0 , 0.1 );
    iterator_type iter2( iter1 );

    // fix by mario: iterator dereference now always gives internal state also for dense output, consistent with other iterator implementations
    // changed: iterators with dense output stepper do not have an internal state now to avoid a copy
    BOOST_CHECK_NE( & (*iter1) , & (*iter2) );
    BOOST_CHECK( iter1.same( iter2 ) );

    ++iter1;
    ++iter2;

    BOOST_CHECK_NE( & (*iter1) , & (*iter2) );
    BOOST_CHECK( iter1.same( iter2 ) );
}

BOOST_AUTO_TEST_CASE( copy_dense_output_stepper_iterator_with_reference_wrapper )
{
    // bad use case, the same stepper is iterated twice
    typedef adaptive_iterator< boost::reference_wrapper< dummy_dense_output_stepper > , empty_system , state_type > iterator_type;

    state_type x = {{ 1.0 }};
    dummy_dense_output_stepper stepper;
    iterator_type iter1( boost::ref( stepper ) , empty_system() , x , 0.0 , 0.9 , 0.1 );
    iterator_type iter2( iter1 );

    BOOST_CHECK_EQUAL( & (*iter1) , & (*iter2) );
    BOOST_CHECK( iter1.same( iter2 ) );
    
    ++iter1;
    ++iter2;
    
    BOOST_CHECK_EQUAL( & (*iter1) , & (*iter2) );
    BOOST_CHECK( !iter1.same( iter2 ) );         // they point to the same stepper, there the times will be different
}



BOOST_AUTO_TEST_CASE( assignment_controlled_stepper_iterator )
{
    typedef adaptive_iterator< dummy_controlled_stepper , empty_system , state_type > iterator_type;
    state_type x1 = {{ 1.0 }} , x2 = {{ 2.0 }};
    iterator_type iter1 = iterator_type( dummy_controlled_stepper() , empty_system() , x1 , 0.0 , 1.0 , 0.1 );
    iterator_type iter2 = iterator_type( dummy_controlled_stepper() , empty_system() , x2 , 0.0 , 1.0 , 0.2 );
    BOOST_CHECK_EQUAL( &(*iter1) , &x1 );
    BOOST_CHECK_EQUAL( &(*iter2) , &x2 );
    // the iterators are indeed the same as this only checks the time values
    BOOST_CHECK( !iter1.same( iter2 ) );
    iter2 = iter1;
    BOOST_CHECK_EQUAL( &(*iter1) , &x1 );
    BOOST_CHECK_EQUAL( &(*iter2) , &x1 );
    BOOST_CHECK( iter1.same( iter2 ) );
}



BOOST_AUTO_TEST_CASE( assignment_dense_output_stepper_iterator )
{
    typedef adaptive_iterator< dummy_dense_output_stepper , empty_system , state_type > iterator_type;
    state_type x1 = {{ 1.0 }};
    iterator_type iter1 = iterator_type( dummy_dense_output_stepper() , empty_system() , x1 , 0.0 , 1.0 , 0.1 );
    iterator_type iter2 = iterator_type( dummy_dense_output_stepper() , empty_system() , x1 , 0.0 , 1.0 , 0.2 );

    BOOST_CHECK_NE( & (*iter1) , & (*iter2) );
    BOOST_CHECK( !iter1.same( iter2 ) );

    iter2 = iter1;
    // fix by mario: iterator dereference now always gives internal state also for dense output, consistent with other iterator implementations
    // changed: iterators with dense output stepper do not have an internal state now to avoid a copy
    BOOST_CHECK_NE( & (*iter1) , & (*iter2) );
    BOOST_CHECK( iter1.same( iter2 ) );
}

BOOST_AUTO_TEST_CASE( assignment_dense_output_stepper_iterator_with_reference_wrapper )
{
    typedef adaptive_iterator< boost::reference_wrapper< dummy_dense_output_stepper > , empty_system , state_type > iterator_type;
    state_type x1 = {{ 1.0 }};

    dummy_dense_output_stepper stepper;
    iterator_type iter1 = iterator_type( boost::ref( stepper )  , empty_system() , x1 , 0.0 , 1.0 , 0.1 );
    iterator_type iter2 = iterator_type( boost::ref( stepper ) , empty_system() , x1 , 0.0 , 1.0 , 0.2 );

    BOOST_CHECK_EQUAL( & (*iter1) , & (*iter2) );
    BOOST_CHECK( !iter1.same( iter2 ) );

    iter2 = iter1;

    BOOST_CHECK_EQUAL( & (*iter1) , & (*iter2) );
    BOOST_CHECK( iter1.same( iter2 ) );
}



BOOST_AUTO_TEST_CASE( controlled_stepper_iterator_factory )
{
    dummy_controlled_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    std::for_each(
         make_adaptive_iterator_begin( stepper , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
         make_adaptive_iterator_end( stepper , boost::ref( system ) , x ) ,
         dummy_observer() );

    BOOST_CHECK_CLOSE( x[0] , 3.5 , 1.0e-14 );
}

// just test if it compiles
BOOST_AUTO_TEST_CASE( dense_output_stepper_iterator_factory )
{
    dummy_dense_output_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    std::for_each(
         make_adaptive_iterator_begin( stepper , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
         make_adaptive_iterator_end( stepper , boost::ref( system ) , x ) ,
         dummy_observer() );
}



BOOST_AUTO_TEST_CASE( controlled_stepper_range )
{
    dummy_controlled_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    boost::for_each( make_adaptive_range( stepper , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
                     dummy_observer() );

    BOOST_CHECK_CLOSE( x[0] , 3.5 , 1.0e-14 );
}

// just test if it compiles
BOOST_AUTO_TEST_CASE( dense_output_stepper_range )
{
    dummy_dense_output_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    boost::for_each( make_adaptive_range( stepper , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
                     dummy_observer() );
}


BOOST_AUTO_TEST_CASE( controlled_stepper_iterator_with_reference_wrapper_factory )
{
    dummy_controlled_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    std::for_each(
        make_adaptive_iterator_begin( boost::ref( stepper ) , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
        make_adaptive_iterator_end( boost::ref( stepper ) , boost::ref( system ) , x ) ,
        dummy_observer() );

    BOOST_CHECK_CLOSE( x[0] , 3.5 , 1.0e-14 );
}

// just test if it compiles
BOOST_AUTO_TEST_CASE( dense_output_stepper_iterator_with_reference_wrapper_factory )
{
    dummy_dense_output_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    std::for_each(
        make_adaptive_iterator_begin( boost::ref( stepper ) , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
        make_adaptive_iterator_end( boost::ref( stepper ) , boost::ref( system ) , x ) ,
        dummy_observer() );
}

BOOST_AUTO_TEST_CASE( controlled_stepper_range_with_reference_wrapper )
{
    dummy_controlled_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    boost::for_each( make_adaptive_range( boost::ref( stepper ) , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
                     dummy_observer() );

    BOOST_CHECK_CLOSE( x[0] , 3.5 , 1.0e-14 );
}

// just test if it compiles
BOOST_AUTO_TEST_CASE( dense_output_stepper_range_with_reference_wrapper )
{
    dummy_dense_output_stepper stepper;
    empty_system system;
    state_type x = {{ 1.0 }};

    boost::for_each( make_adaptive_range( boost::ref( stepper ) , boost::ref( system ) , x , 0.0 , 1.0 , 0.1 ) ,
                     dummy_observer() );
}



BOOST_AUTO_TEST_CASE_TEMPLATE( transitivity1 , Stepper , dummy_steppers )
{
    typedef adaptive_iterator< Stepper , empty_system , state_type > stepper_iterator;

    state_type x = {{ 1.0 }};
    stepper_iterator first1( Stepper() , empty_system() , x , 2.5 , 2.0 , 0.1 );
    stepper_iterator last1( Stepper() , empty_system() , x );
    stepper_iterator last2( Stepper() , empty_system() , x );

    BOOST_CHECK( first1 == last1 );
    BOOST_CHECK( first1 == last2 );
    BOOST_CHECK( last1 == last2 );
}



BOOST_AUTO_TEST_CASE_TEMPLATE( copy_algorithm , Stepper , dummy_steppers )
{
    typedef adaptive_iterator< Stepper , empty_system , state_type > stepper_iterator;
    state_type x = {{ 1.0 }};
    std::vector< state_type > res;
    stepper_iterator first( Stepper() , empty_system() , x , 0.0 , 0.35 , 0.1 );
    stepper_iterator last( Stepper() , empty_system() , x );

    std::copy( first , last , std::back_insert_iterator< std::vector< state_type > >( res ) );

    BOOST_CHECK_EQUAL( res.size() , size_t( 5 ) );
    BOOST_CHECK_CLOSE( res[0][0] , 1.0 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[1][0] , 1.25 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[2][0] , 1.5 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[3][0] , 1.75 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[4][0] , 2.0 , 1.0e-14 );
}

BOOST_AUTO_TEST_CASE_TEMPLATE( copy_algorithm_with_factory , Stepper , dummy_steppers )
{
    state_type x = {{ 1.0 }};
    std::vector< state_type > res;
    std::copy( make_adaptive_iterator_begin( Stepper() , empty_system() , x , 0.0 , 0.35 , 0.1 ) ,
               make_adaptive_iterator_end( Stepper() , empty_system() , x ) ,
               std::back_insert_iterator< std::vector< state_type > >( res ) );

    BOOST_CHECK_EQUAL( res.size() , size_t( 5 ) );
    BOOST_CHECK_CLOSE( res[0][0] , 1.0 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[1][0] , 1.25 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[2][0] , 1.5 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[3][0] , 1.75 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[4][0] , 2.0 , 1.0e-14 );
}

BOOST_AUTO_TEST_CASE_TEMPLATE( copy_algorithm_with_range_factory , Stepper , dummy_steppers )
{
    state_type x = {{ 1.0 }};
    std::vector< state_type > res;
    boost::range::copy( make_adaptive_range( Stepper() , empty_system() , x , 0.0 , 0.35 , 0.1 ) ,
                        std::back_insert_iterator< std::vector< state_type > >( res ) );

    BOOST_CHECK_EQUAL( res.size() , size_t( 5 ) );
    BOOST_CHECK_CLOSE( res[0][0] , 1.0 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[1][0] , 1.25 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[2][0] , 1.5 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[3][0] , 1.75 , 1.0e-14 );
    BOOST_CHECK_CLOSE( res[4][0] , 2.0 , 1.0e-14 );
}




BOOST_AUTO_TEST_SUITE_END()