genealogy_t Class Reference

Encodes a genealogy. More...

#include <genealogy.h>

Inheritance diagram for genealogy_t:

Collaboration diagram for genealogy_t:

Public Member Functions
size_t	ndeme (void) const
	number of demes
size_t &	ndeme (void)
	number of demes
size_t	bytesize (void) const
	size of serialized binary form
	genealogy_t (double t0=R_NaReal, size_t ndeme=0)
	genealogy_t (raw_t *o)
	constructor from serialized binary form
	genealogy_t (SEXP o)
	constructor from RAW SEXP (containing binary serialization)
	genealogy_t (const genealogy_t &G)
	copy constructor
genealogy_t &	operator= (const genealogy_t &G)
	copy assignment operator
	genealogy_t (genealogy_t &&)=default
	move constructor
genealogy_t &	operator= (genealogy_t &&)=default
	move assignment operator
	~genealogy_t (void)
	destructor
slate_t &	time (void)
	view/set current time.
slate_t	time (void) const
	view current time.
slate_t &	timezero (void)
	view/set zero time.
slate_t	timezero (void) const
	get zero time.
void	lineage_count (double *tout, int *deme, int *ell, int *sat, int *etype) const
SEXP	lineage_count (void) const
	lineage count and saturation
void	gendat (double *tout, int *anc, int *lin, int *sat, int *type, int *deme, int *index, int *child) const
	genealogy information in list format
SEXP	gendat (void) const
	genealogy information in list format
size_t	nsample (void) const
	number of samples
size_t	nroot (void) const
	number of roots
string_t	yaml (string_t tab="") const
	human/machine-readable info
SEXP	structure (void) const
	R list description.
string_t	newick (bool extended=true) const
	put genealogy at current time into Newick format.
void	valid (void) const
	check the validity of the genealogy.
bool	check_genealogy_size (size_t grace=0) const
	check the size of the genealogy (to prevent memory exhaustion).
ball_t *	birth (ball_t *a, slate_t t, name_t d)
	birth into deme d
ball_t *	birth (node_t *p, name_t d)
	birth of second or subsequent sibling into deme d
void	death (ball_t *a, slate_t t)
	death
ball_t *	graft (slate_t t, name_t d)
	graft a new lineage into deme d
void	sample (ball_t *a, slate_t t)
	insert a sample node
void	sample_death (ball_t *a, slate_t t)
	insert a sample node and simultaneously terminate the lineage
void	migrate (ball_t *a, slate_t t, name_t d=0)
	movement into deme d
void	sample_migrate (ball_t *a, slate_t t, name_t d=0)
	insert a sample node and simultaneously migrate the lineage
genealogy_t &	prune (void)
	prune the tree (drop all black balls)
genealogy_t &	obscure (void)
	erase all deme information
void	curtail (slate_t tnew, slate_t troot)
genealogy_t &	operator+= (const genealogy_t &other)
	merges two genealogies, adjusting time, t0, and ndeme as needed
void	insert_zlb (void)
	insert zero-length branches for samples where needed
void	drop_zlb (void)
	drop all zero-length branches
genealogy_t &	parse (const string_t &s)
	Parse a Newick string and create the indicated genealogy.
Public Member Functions inherited from nodeseq_t
	~nodeseq_t (void)
	destructor
size_t	bytesize (void) const
	size of serialized binary form
void	sort (void)
	order nodes in order of increasing time
pocket_t *	colored (color_t col) const
	Get all balls of a color.
size_t	ntime (slate_t t) const
	Number of distinct timepoints.
size_t	length (void) const
	Number of nodes in the sequence.
node_t *	position (int n)
	traverse to nth node, retrieve pointer
void	move (ball_t *b, node_t *p, node_t *q)
	move ball b from p to q
void	swap (ball_t *a, ball_t *b)
	swap balls a and b, wherever they lie
void	attach (node_t *p, node_t *q)
void	detach (node_t *p)
void	add (node_t *p, ball_t *a)
void	drop (ball_t *a)
void	destroy_node (node_t *p)
	remove a dead root node
void	weed (void)
	drop all dead roots
void	comb (void)
void	trace_lineages (void)
string_t	yaml (string_t tab="") const
	human/machine-readable info
SEXP	structure (void) const
	R list description.
string_t	newick (slate_t t, bool showdeme, bool extended) const
	put genealogy at time t into Newick format.

Private Member Functions
name_t	unique (void)
	get the next unique name
void	clean (void)
	clean up
node_t *	make_node (name_t d=undeme)
void	reuniqify (name_t shift)
	shifts names to avoid overlap
void	repair_tips (void)
void	repair_roots (void)
	roots are added at zero time if needed
node_t *	scan_branch (string_t::const_iterator b, string_t::const_iterator e)

Private Attributes
name_t	_unique
	The next unique name.
slate_t	_t0
	The initial time.
slate_t	_time
	The current time.
size_t	_ndeme
	The number of demes (excluding the undeme).

Static Private Attributes
static const name_t	magic = 1123581321

Friends
raw_t *	operator>> (const genealogy_t &G, raw_t *o)
	binary serialization
raw_t *	operator>> (raw_t *o, genealogy_t &G)
	binary deserialization

Additional Inherited Members
Static Public Member Functions inherited from nodeseq_t
static bool	compare (node_t *p, node_t *q)

Detailed Description

Encodes a genealogy.

A genealogy consists of a sequence of nodes and the current time.

Definition at line 19 of file genealogy.h.

Constructor & Destructor Documentation

genealogy_t() [1/5]

genealogy_t::genealogy_t ( double t0 = R_NaReal, size_t ndeme = 0 )

inline

basic constructor for genealogy class

• t0 = initial time
• ndeme = number of demes (excluding the undeme)

Definition at line 102 of file genealogy.h.

                                                       {
    clean();
    _time = _t0 = slate_t(t0);
    _ndeme = ndeme;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

genealogy_t() [2/5]

genealogy_t::genealogy_t ( raw_t * o )

inline

constructor from serialized binary form

Definition at line 108 of file genealogy.h.

                         {
    o >> *this;
  };

genealogy_t() [3/5]

genealogy_t::genealogy_t ( SEXP o )

inline

constructor from RAW SEXP (containing binary serialization)

Definition at line 112 of file genealogy.h.

                       {
    if (LENGTH(o)==0)
      err("in %s: cannot deserialize a NULL.",__func__);
    PROTECT(o = AS_RAW(o));
    RAW(o) >> *this;
    UNPROTECT(1);
  };

genealogy_t() [4/5]

genealogy_t::genealogy_t ( const genealogy_t & G )

inline

copy constructor

Definition at line 120 of file genealogy.h.

                                     {
    raw_t *o = new raw_t[G.bytesize()];
    G >> o;
    o >> *this;
    delete[] o;
  };

Here is the call graph for this function:

genealogy_t() [5/5]

genealogy_t::genealogy_t ( genealogy_t && )

default

move constructor

Here is the call graph for this function:

~genealogy_t()

genealogy_t::~genealogy_t ( void )

inline

destructor

Definition at line 140 of file genealogy.h.

                      {
    clean();
  };

Here is the call graph for this function:

Member Function Documentation

birth() [1/2]

ball_t * genealogy_t::birth ( ball_t * a, slate_t t, name_t d )

inline

birth into deme d

Definition at line 242 of file genealogy.h.

                                                 {
    time() = t;
    node_t *p = make_node(a->deme());
    ball_t *b = new ball_t (p,p->uniq,black,d);
    p->insert(b);
    p->slate = time();
    add(p,a);
    return b;
  };

Here is the call graph for this function:

birth() [2/2]

ball_t * genealogy_t::birth ( node_t * p, name_t d )

inline

birth of second or subsequent sibling into deme d

Definition at line 252 of file genealogy.h.

                                      {
    ball_t *b = new ball_t(p,unique(),black,d);
    p->insert(b);
    return b;
  };

Here is the call graph for this function:

bytesize()

size_t genealogy_t::bytesize ( void ) const

inline

size of serialized binary form

Definition at line 71 of file genealogy.h.

                               {
    return 3*sizeof(name_t) +
      2*sizeof(slate_t) + nodeseq_t::bytesize();
  };

Here is the call graph for this function:

Here is the caller graph for this function:

check_genealogy_size()

bool genealogy_t::check_genealogy_size ( size_t grace = 0 ) const

inline

check the size of the genealogy (to prevent memory exhaustion).

Definition at line 214 of file genealogy.h.

                                                     {
    static size_t maxq = MEMORY_MAX/(sizeof(node_t)+2*sizeof(ball_t));
    bool ok = true;
    if (size() > maxq+grace) {
      err("maximum genealogy size exceeded!"); // #nocov
    } else if (size() > maxq) {
      ok = false;               // #nocov
    }
    return ok;
  };

Here is the caller graph for this function:

clean()

void genealogy_t::clean ( void )

inlineprivate

clean up

Definition at line 50 of file genealogy.h.

                    {
    _unique = 0;
    _ndeme = 0;
    _t0 = _time = R_NaReal;
  };

Here is the caller graph for this function:

curtail()

void genealogy_t::curtail	(	slate_t	tnew,
		slate_t	troot )

curtail the genealogy by removing nodes with times later than tnew and/or earlier than troot

Definition at line 10 of file curtail.cc.

{
  if (tnew < troot) troot = tnew;
  if (!empty() && tnew < time()) {
    node_t *p = back();
    while (!empty() && p->slate > tnew) {
      ball_t *b;
      while (p->size() > 1) {
        b = p->last_ball();
        switch (b->color) {
        case black:
          p->erase(b); delete b;
          break;
        case green: case blue: // #nocov
          assert(0);           // #nocov
          break;               // #nocov
        }
      }
      b = p->last_ball();
      switch (b->color) {
      case blue:
        b->color = black;
      case black:
        b->deme() = p->deme();
        swap(b,p->green_ball());
      case green:
        destroy_node(p);
        break;
      }
      if (!empty()) p = back();
    }
  }
  time() = tnew;
  if (!empty() && troot > timezero()) {
    node_t *p = front();
    node_t *q;
    while (!empty() && p->slate < troot) {
      ball_t *b;
      assert(p->holds_own());
      while (p->size() > 1) {
        b = p->last_ball();
        switch (b->color) {
        case blue:
          p->erase(b); delete b;
          break;
        case black:
          q = make_node(b->deme());
          q->slate = troot;
          move(b,p,q); push_back(q);
          break;
        case green:
          q = b->child();
          if (q == p) {
            b = p->first_ball();
            q = b->child();
          }
          if (q->slate < troot) {
            move(b,p,q);
          } else {
            node_t *pp = make_node(b->deme());
            pp->slate = troot;
            move(b,p,pp); push_back(pp);
          }
          break;
        }
      }
      destroy_node(p);
      if (!empty()) p = front();
    }
    sort();
  }
  if (troot > timezero()) timezero() = troot;
}

Here is the call graph for this function:

Here is the caller graph for this function:

death()

void genealogy_t::death ( ball_t * a, slate_t t )

inline

death

Definition at line 258 of file genealogy.h.

                                    {
    time() = t;
    drop(a);
  };

Here is the call graph for this function:

drop_zlb()

void genealogy_t::drop_zlb ( void )

inline

drop all zero-length branches

Definition at line 373 of file genealogy.h.

                       {
    for (node_t *p : *this) {
      if (!p->holds_own() &&
          p->slate == p->parent()->slate &&
          p->deme() == p->parent()->deme()) {
        while (!p->empty()) {
          ball_t *b = p->last_ball();
          p->erase(b); p->parent()->insert(b);
        }
        detach(p);
      }
    }
  };

Here is the call graph for this function:

Here is the caller graph for this function:

gendat() [1/2]

void genealogy_t::gendat	(	double *	tout,
		int *	anc,
		int *	lin,
		int *	sat,
		int *	type,
		int *	deme,
		int *	index,
		int *	child ) const

genealogy information in list format

Definition at line 8 of file gendat.cc.

                               {
  int m, n, k;
  node_it i, j;
  for (k = 0, n = 0, i = begin(); i != end(); i++, n++) {
    node_t *p = *i;
    assert(!p->holds(black)); // tree should be pruned first
    tout[n] = p->slate;
    deme[n] = p->deme();
    if (p->is_root()) {
      type[n] = 0;            // root node
    } else if (p->holds(blue)) {
      type[n] = 1;            // sample node
      deme[n] = p->ball(blue)->deme();
    } else {
      type[n] = 2;            // internal node
    }
    lin[n] = p->lineage();    // 0-based indexing
    sat[n] = p->nchildren();
    index[n] = k;
    k += sat[n];
    child[n] = NA_INTEGER;
    if (p->is_root()) {
      anc[n] = n;             // 0-based indexing
    } else {
      for (m = 0, j = begin(); j != i; j++, m++) {
        node_t *q = *j;
        if (p->parent()->uniq == q->uniq) {
          anc[n] = m;
          break;
        }
      }
    }
  }
  tout[n] = time();
  for (k = 0, n = 0, i = begin(); i != end(); i++, n++) {
    node_t *p = *i;
    j = i; j++;
    for (m = n+1; j != end(); m++, j++) {
      node_t *q = *j;
      if (p->uniq == q->parent()->uniq) {
        child[k++] = m;
      }
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

gendat() [2/2]

SEXP genealogy_t::gendat

(

void

)

const

genealogy information in list format

Definition at line 59 of file gendat.cc.

             {
  SEXP t0, tout, anc, lin, sat, type, deme, index, child, ns, nr, nn;
  SEXP out, outn;
  size_t n = length();
  PROTECT(t0 = NEW_NUMERIC(1));
  PROTECT(tout = NEW_NUMERIC(n+1));
  PROTECT(type = NEW_INTEGER(n));
  PROTECT(deme = NEW_INTEGER(n));
  PROTECT(lin = NEW_INTEGER(n));
  PROTECT(sat = NEW_INTEGER(n));
  PROTECT(index = NEW_INTEGER(n));
  PROTECT(child = NEW_INTEGER(n));
  PROTECT(anc = NEW_INTEGER(n));
  PROTECT(ns = NEW_INTEGER(1));
  PROTECT(nr = NEW_INTEGER(1));
  PROTECT(nn = NEW_INTEGER(1));
  PROTECT(out = NEW_LIST(12));
  PROTECT(outn = NEW_CHARACTER(12));
  set_list_elem(out,outn,t0,"t0",0);
  set_list_elem(out,outn,tout,"nodetime",1);
  set_list_elem(out,outn,type,"nodetype",2);
  set_list_elem(out,outn,deme,"deme",3);
  set_list_elem(out,outn,lin,"lineage",4);
  set_list_elem(out,outn,sat,"saturation",5);
  set_list_elem(out,outn,index,"index",6);
  set_list_elem(out,outn,child,"child",7);
  set_list_elem(out,outn,anc,"ancestor",8);
  set_list_elem(out,outn,ns,"nsample",9);
  set_list_elem(out,outn,nr,"nroot",10);
  set_list_elem(out,outn,nn,"nnode",11);
  SET_NAMES(out,outn);
  gendat(REAL(tout),INTEGER(anc),INTEGER(lin),INTEGER(sat),
         INTEGER(type),INTEGER(deme),INTEGER(index),INTEGER(child));
  *REAL(t0) = double(timezero()); // zero-time
  *INTEGER(ns) = nsample();       // number of samples
  *INTEGER(nr) = nroot();         // number of roots
  *INTEGER(nn) = length();        // number of nodes
  UNPROTECT(14);
  return out;
}

Here is the call graph for this function:

Here is the caller graph for this function:

graft()

ball_t * genealogy_t::graft ( slate_t t, name_t d )

inline

graft a new lineage into deme d

Definition at line 263 of file genealogy.h.

                                      {
    time() = t;
    node_t *p = make_node();
    ball_t *b = new ball_t (p,p->uniq,black,d);
    p->insert(b);
    p->slate = timezero();
    push_front(p);
    return b;
  };

Here is the call graph for this function:

insert_zlb()

void genealogy_t::insert_zlb ( void )

inline

insert zero-length branches for samples where needed

Definition at line 358 of file genealogy.h.

                         {
    for (node_t *p : *this) {
      if (p->holds(green) && p->holds(blue)) {
        assert(!p->holds(black)); // genealogy should have already been pruned
        ball_t *b = p->last_ball();
        assert(b->is(blue));
        node_t *q = make_node(p->deme());
        q->slate = p->slate;
        swap(q->green_ball(),b);
        push_back(q);
      }
    }
    sort();
  };

Here is the call graph for this function:

Here is the caller graph for this function:

lineage_count() [1/2]

void genealogy_t::lineage_count	(	double *	tout,
		int *	deme,
		int *	ell,
		int *	sat,
		int *	etype ) const

lineage count, saturation, and event-type. types are:

• 0 = non-event
• -1 = root
• 1 = sample
• 2 = non-sample node
• 3 = end of interval

Definition at line 39 of file lineages.cc.

{
  size_t nd = ndeme()+1;
  slate_t tcur = timezero();
  for (size_t j = 0; j < nd; j++) {
    tout[j] = tcur;
    deme[j] = j;
    sat[j] = ell[j] = 0;
    etype[j] = 0;
  }
  for (const node_t *p : *this) {
    if (tcur < p->slate) {
      tout += nd; ell += nd; sat += nd;
      deme += nd; etype += nd;
      tcur = p->slate;
      for (size_t j = 0; j < nd; j++) {
        tout[j] = tcur;
        deme[j] = j;
        ell[j] = (ell-nd)[j];
        sat[j] = 0;
        etype[j] = 0;
      }
    }
    p->lineage_incr(ell,sat,etype);
  }
  tout += nd; ell += nd; sat += nd;
  deme += nd; etype += nd;
  tcur = time();
  for (size_t j = 0; j < nd; j++) {
    tout[j] = tcur;
    sat[j] = ell[j] = 0;
    deme[j] = j;
    etype[j] = 3;
  }
}

Here is the call graph for this function:

lineage_count() [2/2]

SEXP genealogy_t::lineage_count

(

void

)

const

lineage count and saturation

Definition at line 79 of file lineages.cc.

{
  SEXP tout, deme, ell, sat, etype, out, outn;
  int nt = ntime(timezero())+1;
  int nl = (ndeme()+1)*nt;
  PROTECT(tout = NEW_NUMERIC(nl));
  PROTECT(deme = NEW_INTEGER(nl));
  PROTECT(ell = NEW_INTEGER(nl));
  PROTECT(sat = NEW_INTEGER(nl));
  PROTECT(etype = NEW_INTEGER(nl));
  PROTECT(out = NEW_LIST(5));
  PROTECT(outn = NEW_CHARACTER(5));
  set_list_elem(out,outn,tout,"time",0);
  set_list_elem(out,outn,deme,"deme",1);
  set_list_elem(out,outn,ell,"lineages",2);
  set_list_elem(out,outn,sat,"saturation",3);
  set_list_elem(out,outn,etype,"event_type",4);
  SET_NAMES(out,outn);
  lineage_count(REAL(tout),INTEGER(deme),INTEGER(ell),
                INTEGER(sat),INTEGER(etype));
  UNPROTECT(7);
  return out;
}

Here is the call graph for this function:

Here is the caller graph for this function:

make_node()

node_t * genealogy_t::make_node ( name_t d = undeme )

inlineprivate

create a node holding its own green ball. this does not insert into the genealogy.

Definition at line 229 of file genealogy.h.

                                        {
    check_genealogy_size(0);
    name_t u = unique();
    node_t *p = new node_t(u,_time);
    ball_t *g = new ball_t(p,u,green,d);
    p->green_ball() = g;
    p->insert(g);
    return p;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

migrate()

void genealogy_t::migrate ( ball_t * a, slate_t t, name_t d = 0 )

inline

movement into deme d

Definition at line 292 of file genealogy.h.

                                                    {
    time() = t;
    node_t *p = make_node(a->deme());
    p->slate = time();
    add(p,a);
    a->deme() = d;
  };

Here is the call graph for this function:

ndeme() [1/2]

size_t & genealogy_t::ndeme ( void )

inline

number of demes

Definition at line 63 of file genealogy.h.

                       {
    return _ndeme;
  };

ndeme() [2/2]

size_t genealogy_t::ndeme ( void ) const

inline

number of demes

Definition at line 59 of file genealogy.h.

                            {
    return _ndeme;
  };

Here is the caller graph for this function:

newick()

string_t genealogy_t::newick

(

bool

extended = true

)

const

put genealogy at current time into Newick format.

Definition at line 93 of file newick.cc.

{
  return nodeseq_t::newick(time(),(ndeme() > 0),extended);
}

Here is the call graph for this function:

Here is the caller graph for this function:

nroot()

size_t genealogy_t::nroot ( void ) const

inline

number of roots

Definition at line 192 of file genealogy.h.

                            {
    size_t n = 0;
    for (const node_t *p : *this) {
      if (p->holds_own()) n++;
    }
    return n;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

nsample()

size_t genealogy_t::nsample ( void ) const

inline

number of samples

Definition at line 183 of file genealogy.h.

                              {
    size_t n = 0;
    for (const node_t *p : *this) {
      if (p->holds(blue)) n++;
    }
    return n;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

obscure()

genealogy_t & genealogy_t::obscure ( void )

inline

erase all deme information

Definition at line 321 of file genealogy.h.

                              {
    // erase deme information from black balls.
    pocket_t *blacks = colored(black);
    while (!blacks->empty()) {
      ball_t *a = *(blacks->begin());
      a->deme() = undeme;
      blacks->erase(a);
    }
    delete blacks;
    // erase deme information from nodes.
    for (node_t *p : *this) {
      p->deme() = undeme;
    }
    // drop superfluous nodes (holding just one ball).
    comb();
    ndeme() = 0;
    return *this;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

operator+=()

genealogy_t & genealogy_t::operator+=

(

const genealogy_t &

other

)

merges two genealogies, adjusting time, t0, and ndeme as needed

merge two genealogies:

1. the node-sequences are merged;
2. the root time advances as necessary;
3. the current time retreats as necessary;
4. the unique-name stack advances as necessary.

Definition at line 29 of file sum.cc.

{
  genealogy_t G = other;
  slate_t t = time();
  slate_t t0 = timezero();
  t0 = (t0 > G.timezero()) ? t0 : G.timezero();
  t = (t < G.time()) ? t : G.time();
  G.reuniqify(_unique);
  merge(G,compare);
  timezero() = (timezero() < G.timezero()) ? timezero() : G.timezero();
  time() = (time() > G.time()) ? time() : G.time();
  ndeme() = (ndeme() > G.ndeme()) ? ndeme() : G.ndeme();
  _unique = G._unique;
  curtail(t,t0);
  return *this;
}

Here is the call graph for this function:

operator=() [1/2]

genealogy_t & genealogy_t::operator= ( const genealogy_t & G )

inline

copy assignment operator

Definition at line 127 of file genealogy.h.

                                                {
    clean();
    raw_t *o = new raw_t[G.bytesize()];
    G >> o;
    o >> *this;
    delete[] o;
    return *this;
  };

Here is the call graph for this function:

operator=() [2/2]

genealogy_t & genealogy_t::operator= ( genealogy_t && )

default

move assignment operator

Here is the call graph for this function:

parse()

genealogy_t & genealogy_t::parse

(

const string_t &

s

)

Parse a Newick string and create the indicated genealogy.

Definition at line 130 of file parse.cc.

{
  node_t *p = 0, *q;
  slate_t tf = timezero();
  string_t::const_reverse_iterator b = s.crbegin(), e = b;
  bool open = false;            // branch-string reading-frame open?
  int stack = 0, sqstack = 0;
  if (!s.empty() && *b != ';')
    err("in '%s': invalid Newick format: no final semicolon.",__func__);
  while (b != s.crend()) {
    switch (*b) {
    case ';':                   // root
      if (stack != 0)
        err("in '%s': invalid Newick: unbalanced parentheses.",__func__);
      p = make_node();
      p->slate = timezero();
      push_front(p);
      b++;
      e = b;
      open = true;
      break;
    case ')':                   // internal node
      if (open) {
        q = scan_branch(b.base(),e.base());
        if (q->holds(black))
          err("in '%s': 'type=extant' on internal node.",__func__);
        q->slate += p->slate;
        attach(p,q);
        push_back(q);
        tf = (q->slate > tf) ? q->slate : tf;
        ndeme() = (ndeme() > q->deme()) ? ndeme() : q->deme();
        p = q;
      } else {
        err("in '%s': invalid Newick: missing comma or semicolon.",__func__);
      }
      stack++;
      b++;
      e = b;
      open = true;
      break;
    case '(':                   // tip node, eldest sister
      if (open) {
        q = scan_branch(b.base(),e.base());
        q->slate += p->slate;
        attach(p,q);
        push_back(q);
        tf = (q->slate > tf) ? q->slate : tf;
        ndeme() = (ndeme() > q->deme()) ? ndeme() : q->deme();
      }
      p = p->parent();
      b++;
      stack--;
      e = b;
      open = false;
      break;
    case ',':                   // tip node, younger sister
      if (stack <= 0)
        err("in '%s': invalid Newick string: misplaced comma or unbalanced parentheses.",__func__);
      if (open) {
        q = scan_branch(b.base(),e.base());
        q->slate += p->slate;
        attach(p,q);
        push_back(q);
        tf = (q->slate > tf) ? q->slate : tf;
        ndeme() = (ndeme() > q->deme()) ? ndeme() : q->deme();
      }
      b++;
      e = b;
      open = true;
      break;
    case ']':                   // skip metadata
      sqstack++;
      while (b != s.crend() && sqstack > 0) {
        b++;
        if (*b == ']') sqstack++;
        if (*b == '[') sqstack--;
      }
      if (sqstack != 0)
        err("in '%s': invalid Newick format: unbalanced square brackets.",__func__);
      if (b != s.crend()) b++;
      break;
    default:
      b++;
      break;
    }
  }
  if (stack != 0)
    err("in '%s': invalid Newick format: unbalanced parentheses.",__func__);
  if (open) {
    q = scan_branch(b.base(),e.base());
    q->slate += p->slate;
    attach(p,q);
    push_back(q);
    tf = (q->slate > tf) ? q->slate : tf;
    ndeme() = (ndeme() > q->deme()) ? ndeme() : q->deme();
  }
  time() = tf;
  sort(); repair_tips(); drop_zlb(); weed();
  return *this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

prune()

genealogy_t & genealogy_t::prune ( void )

inline

prune the tree (drop all black balls)

Definition at line 310 of file genealogy.h.

                            {
    pocket_t *blacks = colored(black);
    while (!blacks->empty()) {
      ball_t *b = *(blacks->begin());
      blacks->erase(b);
      drop(b);
    }
    delete blacks;
    return *this;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

repair_roots()

void genealogy_t::repair_roots ( void )

inlineprivate

roots are added at zero time if needed

Definition at line 393 of file genealogy.h.

                           {
    node_nit j = begin();
    while (j != end()) {
      if ((*j)->holds_own() && (*j)->slate > timezero()) {
        node_t *q = make_node();
        q->slate = timezero();
        attach(q,*j);
        push_front(q);
      }
      j++;
    }
    sort();
  };

Here is the call graph for this function:

repair_tips()

void genealogy_t::repair_tips ( void )

private

• tips without descendants are reclassified as samples.
• tips with black balls are swapped out.

Definition at line 8 of file parse.cc.

{
  for (node_t *p : *this) {
    if (p->empty()) {
      ball_t *b = new ball_t(p,p->uniq,blue,p->deme());
      p->insert(b);
    } else if (p->holds(black))
      swap(p->last_ball(),p->green_ball());
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

reuniqify()

void genealogy_t::reuniqify ( name_t shift )

private

shifts names to avoid overlap

Definition at line 20 of file sum.cc.

{
  this->_unique += shift;
  for (node_t *p : *this) p->reuniqify(shift);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sample()

void genealogy_t::sample ( ball_t * a, slate_t t )

inline

insert a sample node

Definition at line 273 of file genealogy.h.

                                     {
    time() = t;
    node_t *p = make_node(a->deme());
    ball_t *b = new ball_t (p,p->uniq,blue,a->deme());
    p->insert(b);
    p->slate = time();
    add(p,a);
  };

Here is the call graph for this function:

sample_death()

void genealogy_t::sample_death ( ball_t * a, slate_t t )

inline

insert a sample node and simultaneously terminate the lineage

Definition at line 282 of file genealogy.h.

                                           {
    time() = t;
    node_t *p = make_node(a->deme());
    ball_t *b = new ball_t (p,p->uniq,blue,a->deme());
    p->insert(b);
    p->slate = time();
    add(p,a);
    drop(a);
  };

Here is the call graph for this function:

sample_migrate()

void genealogy_t::sample_migrate ( ball_t * a, slate_t t, name_t d = 0 )

inline

insert a sample node and simultaneously migrate the lineage

Definition at line 300 of file genealogy.h.

                                                           {
    time() = t;
    node_t *p = make_node(a->deme());
    ball_t *b = new ball_t (p,p->uniq,blue,a->deme());
    p->insert(b);
    p->slate = time();
    add(p,a);
    a->deme() = d;
  };

Here is the call graph for this function:

scan_branch()

node_t * genealogy_t::scan_branch ( string_t::const_iterator b, string_t::const_iterator e )

private

Scan the branch (label+branch-length) string. This has format [&&PhyloPOMP deme=d type=s]s:f

Scan the branch string. This has format s[&&PhyloPOMP deme=d type=s]s:f

Definition at line 100 of file parse.cc.

{
  name_t deme = 0;
  color_t col = green;
  slate_t bl = 0;
  if (b != e) {
    std::smatch m;
    if (std::regex_match(b,e,m,std::regex("^.*?\\[&&PhyloPOMP.+?deme=(\\w+).*?\\].*$")))
      deme = scan_name(m[1].str());
    if (std::regex_match(b,e,m,std::regex("^.*?\\[&&PhyloPOMP.+?type=(\\w+).*?\\].*$")))
      col = scan_color(m[1].str());
    if (std::regex_match(b,e,m,std::regex("^.*:([-+]?[0-9]*\\.?[0-9]+(?:[eE][-+]?[0-9]+)?)$")))
      bl = scan_slate(m[1].str());
    else
      warn("in '%s': in branch-string '%s': no branch-length detected: assuming zero branch length.",
           __func__,string_t(b,e).c_str());
  }
  node_t *q = make_node(deme);
  if (col != green) {
    ball_t *b = new ball_t(q,q->uniq,col,deme);
    q->insert(b);
  }
  q->slate = bl;
  return q;
}

Here is the call graph for this function:

Here is the caller graph for this function:

structure()

SEXP genealogy_t::structure

(

void

)

const

R list description.

Definition at line 84 of file structure.cc.

{
  SEXP O, On, T0, Time, Nodes, Ndeme;
  PROTECT(O = NEW_LIST(4));
  PROTECT(On = NEW_CHARACTER(4));
  PROTECT(Time = NEW_NUMERIC(1));
  *REAL(Time) = double(time());
  PROTECT(T0 = NEW_NUMERIC(1));
  *REAL(T0) = double(timezero());
  PROTECT(Ndeme = NEW_INTEGER(1));
  *INTEGER(Ndeme) = int(ndeme());
  PROTECT(Nodes = nodeseq_t::structure());
  set_list_elem(O,On,Time,"time",0);
  set_list_elem(O,On,T0,"t0",1);
  set_list_elem(O,On,Ndeme,"ndeme",2);
  set_list_elem(O,On,Nodes,"nodes",3);
  SET_NAMES(O,On);
  UNPROTECT(6);
  return O;
}

Here is the call graph for this function:

time() [1/2]

slate_t & genealogy_t::time ( void )

inline

view/set current time.

Definition at line 145 of file genealogy.h.

                       {
    return _time;
  };

Here is the caller graph for this function:

time() [2/2]

slate_t genealogy_t::time ( void ) const

inline

view current time.

Definition at line 149 of file genealogy.h.

                            {
    return _time;
  };

timezero() [1/2]

slate_t & genealogy_t::timezero ( void )

inline

view/set zero time.

Definition at line 153 of file genealogy.h.

                           {
    return _t0;
  };

Here is the caller graph for this function:

timezero() [2/2]

slate_t genealogy_t::timezero ( void ) const

inline

get zero time.

Definition at line 157 of file genealogy.h.

                                {
    return _t0;
  };

unique()

name_t genealogy_t::unique ( void )

inlineprivate

get the next unique name

Definition at line 43 of file genealogy.h.

                       {
    name_t u = _unique;
    _unique++;
    return u;
  };

Here is the caller graph for this function:

valid()

void genealogy_t::valid ( void ) const

inline

check the validity of the genealogy.

Definition at line 212 of file genealogy.h.

{};

yaml()

string_t genealogy_t::yaml

(

string_t

tab = ""

)

const

human/machine-readable info

Definition at line 63 of file yaml.cc.

{
  string_t o;
  string_t t = tab + "  ";
  o = tab + "t0: " + std::to_string(timezero()) + "\n"
    + tab + "time: " + std::to_string(time()) + "\n"
    + tab + "ndeme: " + std::to_string(ndeme()) + "\n"
    + tab + "nodes:\n" + nodeseq_t::yaml(tab);
  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 genealogy_t & G, raw_t * o )

friend

binary serialization

Definition at line 76 of file genealogy.h.

                                                            {
    name_t A[3]; A[0] = magic; A[1] = G._unique; A[2] = name_t(G.ndeme());
    slate_t B[2]; B[0] = G.timezero(); B[1] = G.time();
    memcpy(o,A,sizeof(A)); o += sizeof(A);
    memcpy(o,B,sizeof(B)); o += sizeof(B);
    return reinterpret_cast<const nodeseq_t&>(G) >> o;
  };

operator>> [2/2]

raw_t * operator>> ( raw_t * o, genealogy_t & G )

friend

binary deserialization

Definition at line 84 of file genealogy.h.

                                                      {
    G.clean();
    name_t A[3];
    slate_t B[2];
    memcpy(A,o,sizeof(A)); o += sizeof(A);
    memcpy(B,o,sizeof(B)); o += sizeof(B);
    if (A[0] != magic)
      err("in %s: corrupted genealogy serialization.",__func__);
    G._unique = A[1]; G.ndeme() = size_t(A[2]);
    G.timezero() = B[0]; G.time() = B[1];
    return o >> reinterpret_cast<nodeseq_t&>(G);
  };

Field Documentation

_ndeme

size_t genealogy_t::_ndeme

private

The number of demes (excluding the undeme).

Definition at line 36 of file genealogy.h.

_t0

slate_t genealogy_t::_t0

private

The initial time.

Definition at line 32 of file genealogy.h.

_time

slate_t genealogy_t::_time

private

The current time.

Definition at line 34 of file genealogy.h.

_unique

name_t genealogy_t::_unique

private

The next unique name.

Definition at line 30 of file genealogy.h.

magic

const name_t genealogy_t::magic = 1123581321

staticprivate

Definition at line 38 of file genealogy.h.

---

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

• src/genealogy.h
• src/curtail.cc
• src/gendat.cc
• src/lineages.cc
• src/newick.cc
• src/parse.cc
• src/structure.cc
• src/sum.cc
• src/yaml.cc