Particles Class Reference

A collection of particles. More...

#include <particles.hpp>

Public Member Functions
std::vector< Particle >::iterator	begin ()
std::vector< Particle >::const_iterator	begin () const
std::vector< Particle >::iterator	end ()
std::vector< Particle >::const_iterator	end () const
int	size () const
	Get the number of particles.
void	add (const Particle &particle)
	Add a particle to the collection.
Particle &	operator[] (size_t index)
	Get a particle by index.
const Particle &	operator[] (size_t index) const
	Get a particle by index.

Private Attributes
std::vector< Particle >	particles

Detailed Description

A collection of particles.

Definition at line 10 of file particles.hpp.

Member Function Documentation

begin() [1/2]

std::vector< Particle >::iterator Particles::begin

(

)

Definition at line 5 of file particles.cpp.

                                             {
    return particles.begin();
}

begin() [2/2]

std::vector< Particle >::const_iterator Particles::begin

(

)

const

Definition at line 9 of file particles.cpp.

                                                         {
    return particles.begin();
}

end() [1/2]

std::vector< Particle >::iterator Particles::end

(

)

Definition at line 13 of file particles.cpp.

                                           {
    return particles.end();
}

end() [2/2]

std::vector< Particle >::const_iterator Particles::end

(

)

const

Definition at line 17 of file particles.cpp.

                                                       {
    return particles.end();
}

size()

int Particles::size

(

)

const

Get the number of particles.

Returns

int the number of particles

Definition at line 21 of file particles.cpp.

                          {
    return particles.size();
}

Here is the caller graph for this function:

add()

void Particles::add

(

const Particle &

particle

)

Add a particle to the collection.

Parameters

particle

the particle to add

Definition at line 25 of file particles.cpp.

                                            {
    // This class assumes that the index of the inner vector is equal to the id of the particle located there.
    // To ensure this, assert that the id of the particle is equal to the size of the inner vector.
    assert(particle.id == particles.size());
    particles.emplace_back(particle);
}

Here is the caller graph for this function:

operator[]() [1/2]

Particle & Particles::operator[]

(

size_t

index

)

Get a particle by index.

Parameters

index

the index of the particle

Returns

Particle& the particle

Definition at line 32 of file particles.cpp.

                                            {
    return particles[index];
}

operator[]() [2/2]

const Particle & Particles::operator[]

(

size_t

index

)

const

Get a particle by index.

Parameters

index

the index of the particle

Returns

const Particle& the particle

Definition at line 36 of file particles.cpp.

                                                        {
    return particles[index];
}

Member Data Documentation

particles

std::vector<Particle> Particles::particles

private

Definition at line 49 of file particles.hpp.

---

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

• src/particles.hpp
• src/particles.cpp