Emrys::ParticleSet< Space_, Scalar_, Allocator_ >::MutableParticle Class Reference

Writable access to one particle during forEach(). More...

#include <EmrysFilter/Distributions/ParticleSet.h>

Public Member Functions
	MutableParticle (MutableParticle const &)=delete
	lives only inside the callback
MutableParticle &	operator= (MutableParticle const &)=delete
	Lives only inside the callback.
Index	index () const
Scalar	logWeight () const
ConstStateType	state () const
template<typename Derived>
void	setState (Eigen::MatrixBase< Derived > const &state)
	Sets the particle's state, normalized by the space.

Detailed Description

template<Space Space_, RealScalar Scalar_ = double, typename Allocator_ = DefaultAllocator>
class Emrys::ParticleSet< Space_, Scalar_, Allocator_ >::MutableParticle

Writable access to one particle during forEach().

Exists only for the duration of the callback; it cannot be copied or moved.

Member Function Documentation

index()

template<Space Space_, RealScalar Scalar_ = double, typename Allocator_ = DefaultAllocator>

Index Emrys::ParticleSet< Space_, Scalar_, Allocator_ >::MutableParticle::index ( ) const

inlinenodiscard

Returns

the particle's index in the set

logWeight()

template<Space Space_, RealScalar Scalar_ = double, typename Allocator_ = DefaultAllocator>

Scalar Emrys::ParticleSet< Space_, Scalar_, Allocator_ >::MutableParticle::logWeight ( ) const

inlinenodiscard

Returns

the particle's log-weight

state()

template<Space Space_, RealScalar Scalar_ = double, typename Allocator_ = DefaultAllocator>

ConstStateType Emrys::ParticleSet< Space_, Scalar_, Allocator_ >::MutableParticle::state ( ) const

inlinenodiscard

Returns

the particle's state

---

The documentation for this class was generated from the following file:

• EmrysFilter/Distributions/ParticleSet.h