ball_t Class Reference

Balls function as pointers. More...

#include <ball.h>

Collaboration diagram for ball_t:

Public Member Functions
	ball_t (node_t *who=0, name_t u=0, color_t col=green, name_t d=undeme)
	basic constructor for ball class
	ball_t (const ball_t &)=delete
	copy constructor
	ball_t (ball_t &&)=delete
	move constructor
ball_t &	operator= (const ball_t &)=delete
	copy assignment operator
ball_t &	operator= (ball_t &&)=delete
	move assignment operator
	~ball_t (void)=default
	destructor
name_t	deme (void) const
	view deme
name_t &	deme (void)
	change deme
node_t *	owner (void) const
	view owner of a green ball
node_t *&	owner (void)
	change owner of a green ball
node_t *	child (void) const
	a child is the owner of a green ball
node_t *	holder (void) const
	in whose pocket do I lie?
node_t *&	holder (void)
	in whose pocket do I lie?
bool	is (color_t c) const
	is a given ball of the given color?
string_t	color_name (void) const
	human-readable colors
string_t	color_symbol (void) const
	machine-readable color symbols
string_t	yaml (string_t tab="") const
	human/machine-readable info
SEXP	structure (void) const
	R list description.
string_t	newick (const slate_t &t, bool showdeme) const

Data Fields
name_t	uniq
color_t	color

Static Public Attributes
static const size_t	bytesize = 2*sizeof(name_t)+sizeof(color_t)
	size of binary serialization

Private Attributes
node_t *	_holder
node_t *	_owner
name_t	_deme

Friends
raw_t *	operator>> (const ball_t &b, raw_t *o)
	binary serialization
raw_t *	operator>> (raw_t *o, ball_t &b)
	binary deserialization

Detailed Description

Balls function as pointers.

Each ball has:

• a globally unique name
• a color
• a deme
• a "holder": a pointer to the node in whose pocket it lies
• an "owner": a pointer to the node in which it was originally created

Definition at line 27 of file ball.h.

Constructor & Destructor Documentation

ball_t() [1/3]

ball_t::ball_t ( node_t * who = 0, name_t u = 0, color_t col = green, name_t d = undeme )

inline

basic constructor for ball class

Definition at line 63 of file ball.h.

                                                  {
    _holder = _owner = who;
    uniq = u;
    color = col;
    _deme = d;
  };

Here is the caller graph for this function:

ball_t() [2/3]

ball_t::ball_t ( const ball_t & )

delete

copy constructor

Here is the call graph for this function:

ball_t() [3/3]

ball_t::ball_t ( ball_t && )

delete

move constructor

Here is the call graph for this function:

~ball_t()

ball_t::~ball_t ( void )

default

destructor

Member Function Documentation

child()

node_t * ball_t::child ( void ) const

inline

a child is the owner of a green ball

Definition at line 102 of file ball.h.

                             {
    assert(color==green);
    return _owner;
  };

Here is the caller graph for this function:

color_name()

string_t ball_t::color_name ( void ) const

inline

human-readable colors

Definition at line 119 of file ball.h.

                                   {
    return colores[color];
  };

Here is the caller graph for this function:

color_symbol()

string_t ball_t::color_symbol ( void ) const

inline

machine-readable color symbols

Definition at line 123 of file ball.h.

                                     {
    if (is(green) && _holder==_owner)
      return "m";               // brown balls
    else
      return colorsymb[color];
  };

Here is the call graph for this function:

Here is the caller graph for this function:

deme() [1/2]

name_t & ball_t::deme ( void )

inline

change deme

Definition at line 88 of file ball.h.

                      {
    return _deme;
  };

deme() [2/2]

name_t ball_t::deme ( void ) const

inline

view deme

Definition at line 84 of file ball.h.

                           {
    return _deme;
  };

Here is the caller graph for this function:

holder() [1/2]

node_t *& ball_t::holder ( void )

inline

in whose pocket do I lie?

Definition at line 111 of file ball.h.

                         {
    return _holder;
  };

holder() [2/2]

node_t * ball_t::holder ( void ) const

inline

in whose pocket do I lie?

Definition at line 107 of file ball.h.

                              {
    return _holder;
  };

Here is the caller graph for this function:

is()

bool ball_t::is ( color_t c ) const

inline

is a given ball of the given color?

Definition at line 115 of file ball.h.

                            {
    return color==c;
  };

Here is the caller graph for this function:

newick()

string_t ball_t::newick	(	const slate_t &	t,
		bool	showdeme ) const

Element of a Newick representation. This should only be called at tip-nodes.

Definition at line 14 of file newick.cc.

{
  assert(color==black);
  string_t o = "[&&PhyloPOMP type=extant";
  if (showdeme)
    o += " deme=" + std::to_string(deme());
  o += "]"
    + std::to_string(uniq) +
    ":" + std::to_string(t);
  return o;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

ball_t & ball_t::operator= ( ball_t && )

delete

move assignment operator

Here is the call graph for this function:

operator=() [2/2]

ball_t & ball_t::operator= ( const ball_t & )

delete

copy assignment operator

Here is the call graph for this function:

owner() [1/2]

node_t *& ball_t::owner ( void )

inline

change owner of a green ball

Definition at line 97 of file ball.h.

                        {
    assert(color==green);
    return _owner;
  };

owner() [2/2]

node_t * ball_t::owner ( void ) const

inline

view owner of a green ball

Definition at line 92 of file ball.h.

                             {
    assert(color==green);
    return _owner;
  };

Here is the caller graph for this function:

structure()

SEXP ball_t::structure

(

void

)

const

R list description.

Definition at line 15 of file structure.cc.

{
  SEXP O, On, Name, Color, Deme;
  int size = (is(black)) ? 3 : 2;
  PROTECT(O = NEW_LIST(size));
  PROTECT(On = NEW_CHARACTER(size));
  PROTECT(Name = NEW_INTEGER(1));
  *INTEGER(Name) = int(uniq);
  PROTECT(Color = NEW_CHARACTER(1));
  SET_STRING_ELT(Color,0,mkChar(color_symbol().c_str()));
  set_list_elem(O,On,Name,"name",0);
  set_list_elem(O,On,Color,"color",1);
  if (is(black)) {
    PROTECT(Deme = NEW_INTEGER(1));
    *INTEGER(Deme) = int(deme());
    set_list_elem(O,On,Deme,"deme",2);
    UNPROTECT(1);
  }
  SET_NAMES(O,On);
  UNPROTECT(4);
  return O;
}

Here is the call graph for this function:

yaml()

string_t ball_t::yaml

(

string_t

tab = ""

)

const

human/machine-readable info

Definition at line 11 of file yaml.cc.

{
  string_t o;
  o = "color: " + color_name() + "\n"
    + tab + "name: " + std::to_string(uniq) + "\n";
  if (color==black) {
    o += tab + "deme: " + std::to_string(deme()) + "\n";
  }
  return o;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

operator>> [1/2]

raw_t * operator>> ( const ball_t & b, raw_t * o )

friend

binary serialization

Definition at line 43 of file ball.h.

                                                       {
    name_t buf[2] = {b.uniq, b._deme};
    memcpy(o,buf,sizeof(buf)); o += sizeof(buf);
    memcpy(o,&b.color,sizeof(color_t)); o += sizeof(color_t);
    return o;
  };

operator>> [2/2]

raw_t * operator>> ( raw_t * o, ball_t & b )

friend

binary deserialization

Definition at line 50 of file ball.h.

                                                 {
    name_t buf[2];
    memcpy(buf,o,sizeof(buf)); o += sizeof(buf);
    b.uniq = buf[0]; b._deme = buf[1];
    memcpy(&b.color,o,sizeof(color_t)); o += sizeof(color_t);
    b._holder = 0;              // must be set elsewhere
    b._owner = 0;               // must be set elsewhere
    return o;
  };

Field Documentation

_deme

name_t ball_t::_deme

private

Definition at line 32 of file ball.h.

_holder

node_t* ball_t::_holder

private

Definition at line 30 of file ball.h.

_owner

node_t* ball_t::_owner

private

Definition at line 31 of file ball.h.

bytesize

const size_t ball_t::bytesize = 2*sizeof(name_t)+sizeof(color_t)

static

size of binary serialization

Definition at line 41 of file ball.h.

color

color_t ball_t::color

Definition at line 36 of file ball.h.

uniq

name_t ball_t::uniq

Definition at line 35 of file ball.h.

---

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

• src/ball.h
• src/newick.cc
• src/structure.cc
• src/yaml.cc