single_particle.hpp

Go to the documentation of this file.

//============================================================================
// vSMC/include/vsmc/core/single_particle.hpp
//----------------------------------------------------------------------------
//                         vSMC: Scalable Monte Carlo
//----------------------------------------------------------------------------
// Copyright (c) 2013,2014, Yan Zhou
// 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 HOLDER 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.
//============================================================================

#ifndef VSMC_CORE_SINGLE_PARTICLE_HPP
#define VSMC_CORE_SINGLE_PARTICLE_HPP

#include <vsmc/internal/common.hpp>

namespace vsmc {

template <typename T>
class SingleParticleBase
{
    public :

    SingleParticleBase (typename Particle<T>::size_type id,
            Particle<T> *particle_ptr) :
        id_(id), particle_ptr_(particle_ptr) {}

    typename Particle<T>::size_type id () const {return id_;}

    const Particle<T> &particle () const {return *particle_ptr_;}

    const Particle<T> *particle_ptr () const {return particle_ptr_;}

    typename Particle<T>::rng_type &rng () const
    {return particle_ptr_->rng(id_);}

    protected :

    Particle<T> &mutable_particle () const {return *particle_ptr_;}

    Particle<T> *mutable_particle_ptr () const {return particle_ptr_;}

    private :

    typename Particle<T>::size_type id_;
    Particle<T> *particle_ptr_;
}; // class SingleParticleBase

template <typename T>
class ConstSingleParticleBase
{
    public :

    ConstSingleParticleBase (typename Particle<T>::size_type id,
            const Particle<T> *particle_ptr) :
        id_(id), particle_ptr_(particle_ptr) {}

    typename Particle<T>::size_type id () const {return id_;}

    const Particle<T> &particle () const {return *particle_ptr_;}

    const Particle<T> *particle_ptr () const {return particle_ptr_;}

    private :

    typename Particle<T>::size_type id_;
    const Particle<T> *particle_ptr_;
}; // class ConstSingleParticleBase

template <typename T>
class SingleParticle :
    public traits::SingleParticleBaseTypeTrait<T>::type
{
    typedef typename traits::SingleParticleBaseTypeTrait<T>::type base;

    public :

    SingleParticle (typename Particle<T>::size_type id,
            Particle<T> *particle_ptr) : base(id, particle_ptr) {}
}; // class SingleParticle

template <typename T>
class ConstSingleParticle :
    public traits::ConstSingleParticleBaseTypeTrait<T>::type
{
    typedef typename traits::ConstSingleParticleBaseTypeTrait<T>::type base;

    public :

    ConstSingleParticle (typename Particle<T>::size_type id,
            const Particle<T> *particle_ptr) : base(id, particle_ptr) {}
}; // class ConstSingleParticle

} // namespace vsmc

#endif // VSMC_CORE_SINGLE_PARTICLE_HPP