inventory_t< NDEME > Class Template Reference

Representation for the inventory process. More...

#include <inventory.h>

Collaboration diagram for inventory_t< NDEME >:

Public Member Functions
	inventory_t (void)=default
	basic constructor for inventory class
	inventory_t (raw_t *o)
	constructor from serialized binary form
	inventory_t (std::pair< node_it, node_it > &&I)
	inventory_t (const inventory_t &)=default
	copy constructor
	inventory_t (inventory_t &&)=delete
	move constructor
inventory_t &	operator= (std::pair< node_it, node_it > &&I)
	copy an inventory by iterating over a node sequence
inventory_t &	operator= (const inventory_t &)=default
	copy assignment operator
inventory_t &	operator= (inventory_t &&)=delete
	move assignment operator
	~inventory_t (void)
	destructor
void	clean (void)
	memory cleanup
void	clear (void)
	memory cleanup
size_t	bytesize (void) const
	size of serialized binary form
size_t	size (void) const
size_t	size (name_t i) const
	size of deme
pocket_t &	operator[] (const name_t n)
	return the n-th deme
bool	empty (void) const
	are all demes empty?
ball_t *	random_ball (name_t i=0) const
	choose one random ball from deme i
pocket_t *	random_balls (name_t i=0, int n=1) const
	choose a random set of n balls from deme i
void	insert (ball_t *b)
void	erase (ball_t *b)

Private Attributes
pocket_t	_inven [NDEME]

Static Private Attributes
static const size_t	ndeme = NDEME

Friends
raw_t *	operator>> (const inventory_t &I, raw_t *o)
	binary serialization
raw_t *	operator>> (raw_t *o, inventory_t &I)
	binary deserialization

Detailed Description

template<size_t NDEME = 1>
class inventory_t< NDEME >

Representation for the inventory process.

An inventory consists of an array of demes. Each deme is a set of black balls.

Definition at line 18 of file inventory.h.

Constructor & Destructor Documentation

inventory_t() [1/5]

template<size_t NDEME = 1>

inventory_t< NDEME >::inventory_t ( void )

default

basic constructor for inventory class

Here is the caller graph for this function:

inventory_t() [2/5]

template<size_t NDEME = 1>

inventory_t< NDEME >::inventory_t ( raw_t * o )

inline

constructor from serialized binary form

Definition at line 31 of file inventory.h.

                         {
    o >> *this;
  };

inventory_t() [3/5]

template<size_t NDEME = 1>

inventory_t< NDEME >::inventory_t ( std::pair< node_it, node_it > && I )

inline

constructor from node sequence (via 'extant' operation). this constructs an inventory from a genealogy.

Definition at line 36 of file inventory.h.

                                             {
    clean();
    for (node_it i = I.first; i != I.second; i++) {
      for (ball_t *b : **i) {
        insert(b);              // 'insert' checks color
      }
    }
  };

Here is the call graph for this function:

inventory_t() [4/5]

template<size_t NDEME = 1>

inventory_t< NDEME >::inventory_t ( const inventory_t< NDEME > & )

default

copy constructor

Here is the call graph for this function:

inventory_t() [5/5]

template<size_t NDEME = 1>

inventory_t< NDEME >::inventory_t ( inventory_t< NDEME > && )

delete

move constructor

Here is the call graph for this function:

~inventory_t()

template<size_t NDEME = 1>

inventory_t< NDEME >::~inventory_t ( void )

inline

destructor

Definition at line 63 of file inventory.h.

                      {
    clean();
  };

Here is the call graph for this function:

Member Function Documentation

bytesize()

template<size_t NDEME = 1>

size_t inventory_t< NDEME >::bytesize ( void ) const

inline

size of serialized binary form

Definition at line 77 of file inventory.h.

                               {
    size_t s = 0;
    for (size_t i = 0; i < ndeme; i++)
      s += _inven[i].bytesize();
    return s;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

clean()

template<size_t NDEME = 1>

void inventory_t< NDEME >::clean ( void )

inline

memory cleanup

Definition at line 67 of file inventory.h.

                    {
    clear();
  };

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

template<size_t NDEME = 1>

void inventory_t< NDEME >::clear ( void )

inline

memory cleanup

Definition at line 71 of file inventory.h.

                    {
    for (size_t i = 0; i < ndeme; i++)
      _inven[i].clear();
  };

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

template<size_t NDEME = 1>

bool inventory_t< NDEME >::empty ( void ) const

inline

are all demes empty?

Definition at line 116 of file inventory.h.

                          {
    bool q = true;
    for (name_t i = 0; i < ndeme; i++) {
      q = q && _inven[i].empty();
    }
    return q;
  };

erase()

template<size_t NDEME = 1>

void inventory_t< NDEME >::erase ( ball_t * b )

inline

remove a black ball from its deme. this checks the color of the ball. if it is not black, nothing is done.

Definition at line 168 of file inventory.h.

                         {
    if (b->is(black)) {
      assert(!(_inven[b->deme()].empty()));
      _inven[b->deme()].erase(b);
    }
  };

Here is the call graph for this function:

insert()

template<size_t NDEME = 1>

void inventory_t< NDEME >::insert ( ball_t * b )

inline

add a black ball to a deme. this checks the color of the ball. if it is not black, nothing is done.

Definition at line 160 of file inventory.h.

                          {
    if (b->is(black)) {
      _inven[b->deme()].insert(b);
    }
  };

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/3]

template<size_t NDEME = 1>

inventory_t & inventory_t< NDEME >::operator= ( const inventory_t< NDEME > & )

default

copy assignment operator

Here is the call graph for this function:

operator=() [2/3]

template<size_t NDEME = 1>

inventory_t & inventory_t< NDEME >::operator= ( inventory_t< NDEME > && )

delete

move assignment operator

Here is the call graph for this function:

operator=() [3/3]

template<size_t NDEME = 1>

inventory_t & inventory_t< NDEME >::operator= ( std::pair< node_it, node_it > && I )

inline

copy an inventory by iterating over a node sequence

Definition at line 49 of file inventory.h.

                                                        {
    clean();
    for (node_it i = I.first; i != I.second; i++) {
      for (ball_t *b : **i) {
        insert(b);              // 'insert' checks color
      }
    }
    return *this;
  };

Here is the call graph for this function:

operator[]()

template<size_t NDEME = 1>

pocket_t & inventory_t< NDEME >::operator[] ( const name_t n )

inline

return the n-th deme

Definition at line 112 of file inventory.h.

                                        {
    return _inven[n];
  };

random_ball()

template<size_t NDEME = 1>

ball_t * inventory_t< NDEME >::random_ball ( name_t i = 0 ) const

inline

choose one random ball from deme i

Definition at line 124 of file inventory.h.

                                           {
    name_t n = _inven[i].size();
    assert(n > 0);
    name_t draw = random_integer(n);
    ball_it k = _inven[i].begin();
    while (draw-- > 0) k++;
    return *k;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

random_balls()

template<size_t NDEME = 1>

pocket_t * inventory_t< NDEME >::random_balls ( name_t i = 0, int n = 1 ) const

inline

choose a random set of n balls from deme i

Definition at line 133 of file inventory.h.

                                                         {
    pocket_t *p = new pocket_t();
    if (n == 1) {
      ball_t *b = random_ball(i);
      p->insert(b);
    } else if (n > 1) {
      int N = _inven[i].size();
      assert(N > 0);
      assert(n <= N);
      ball_it j = _inven[i].begin();
      int k = 0, m = 0;
      while (m < n && k < N) {
        int u = random_integer(N-k);
        if (u < n-m) {
          p->insert(*j);
          m++;
        }
        k++; j++;
      }
    } else {
      assert(0);                // #nocov
    }
    return p;
  };

Here is the call graph for this function:

size() [1/2]

template<size_t NDEME = 1>

size_t inventory_t< NDEME >::size ( name_t i ) const

inline

size of deme

Definition at line 108 of file inventory.h.

                               {
    return _inven[i].size();
  };

size() [2/2]

template<size_t NDEME = 1>

size_t inventory_t< NDEME >::size ( void ) const

inline

Total number of balls in an inventory. i.e., the sum of the sizes of all demes

Definition at line 100 of file inventory.h.

                           {
    size_t n = 0;
    for (name_t i = 0; i < ndeme; i++) {
      n += size(i);
    }
    return n;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

operator>> [1/2]

template<size_t NDEME = 1>

raw_t * operator>> ( const inventory_t< NDEME > & I, raw_t * o )

friend

binary serialization

Definition at line 84 of file inventory.h.

                                                            {
    for (size_t i = 0; i < ndeme; i++) {
      o = (I._inven[i] >> o);
    }
    return o;
  };

operator>> [2/2]

template<size_t NDEME = 1>

raw_t * operator>> ( raw_t * o, inventory_t< NDEME > & I )

friend

binary deserialization

Definition at line 91 of file inventory.h.

                                                      {
    I.clean();
    for (size_t i = 0; i < ndeme; i++) {
      o = (o >> I._inven[i]);
    }
    return o;
  };

Field Documentation

_inven

template<size_t NDEME = 1>

pocket_t inventory_t< NDEME >::_inven[NDEME]

private

Definition at line 22 of file inventory.h.

ndeme

template<size_t NDEME = 1>

const size_t inventory_t< NDEME >::ndeme = NDEME

staticprivate

Definition at line 23 of file inventory.h.

---

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

• src/inventory.h