TTNeutralGenes_byte Class Reference

Byte-encoded neutral gene trait (unsigned char per allele). More...

#include <ttneutralgenes.h>

Inheritance diagram for TTNeutralGenes_byte:

Collaboration diagram for TTNeutralGenes_byte:

Public Member Functions
	TTNeutralGenes_byte ()
	TTNeutralGenes_byte (const TTNeutralGenes_byte &T)
virtual	~TTNeutralGenes_byte ()
Accessors
void	set_mut_func_ptr (void(TTNeutralGenes_byte::*theFunc)(void))
void	set_inherit_func_ptr (void(TProtoNeutralGenes::*theFunc)(sex_t, unsigned char *, const unsigned char **))
void	set_allele (unsigned int loc, unsigned int al, unsigned char val)
Mutation models
void	mutate_SSM ()
void	mutate_KAM ()
void	mutate_2all ()
void	mutate_NULL ()
Implementations
virtual TTNeutralGenes &	operator= (const TTrait &T)
virtual void	init ()
virtual void	init_sequence ()
virtual void	reset ()
virtual void **	get_sequence () const
virtual unsigned int	get_allele (int loc, int all) const
virtual double	get_allele_value (int loc, int all) const
virtual void	set_allele_value (unsigned int locus, unsigned int allele, double value)
virtual void	set_sequence (void **seq)
virtual void	inherit (const TTrait *mother, const TTrait *father)
virtual void	mutate ()
virtual void	show_up ()
virtual TTNeutralGenes *	clone ()
virtual void	store_data (BinaryStorageBuffer *saver)
virtual bool	retrieve_data (BinaryStorageBuffer *reader)
Public Member Functions inherited from TTNeutralGenes
	TTNeutralGenes ()
	TTNeutralGenes (const TTNeutralGenes &T)
virtual	~TTNeutralGenes ()
void	set_proto (TProtoNeutralGenes *proto)
virtual bool	operator== (const TTrait &T)
virtual bool	operator!= (const TTrait &T)
virtual void *	set_trait (void *value)
virtual trait_t	get_type () const
virtual void	set_value ()
virtual void *	getValue () const
Public Member Functions inherited from TTrait
virtual	~TTrait ()
Public Member Functions inherited from StorableComponent
virtual	~StorableComponent ()

Private Attributes
void(TTNeutralGenes_byte::*	_mutate_func_ptr )(void)
void(TProtoNeutralGenes::*	_inherit_func_ptr )(sex_t, unsigned char *, const unsigned char **)
unsigned char **	_sequence

Additional Inherited Members
Protected Attributes inherited from TTNeutralGenes
TProtoNeutralGenes *	_myProto
const trait_t	_type

Detailed Description

Byte-encoded neutral gene trait (unsigned char per allele).

Used for multi-allelic loci.

Constructor & Destructor Documentation

TTNeutralGenes_byte() [1/2]

TTNeutralGenes_byte::TTNeutralGenes_byte ( )

inline

    : TTNeutralGenes(), _mutate_func_ptr(0), _inherit_func_ptr(0), _sequence(0) { }

Referenced by clone().

TTNeutralGenes_byte() [2/2]

TTNeutralGenes_byte::TTNeutralGenes_byte ( const TTNeutralGenes_byte &  T )

inline

    : TTNeutralGenes(T), _mutate_func_ptr(T._mutate_func_ptr), _inherit_func_ptr(T._inherit_func_ptr),
    _sequence(0) { }

~TTNeutralGenes_byte()

TTNeutralGenes_byte::~TTNeutralGenes_byte ( )

virtual

{
  if(_sequence != NULL){
    for(unsigned int i = 0; i < _myProto->get_ploidy(); i++)
      delete [] _sequence[i];
    delete [] _sequence;
  }
}

References TTNeutralGenes::_myProto, _sequence, and TProtoNeutralGenes::get_ploidy().

Member Function Documentation

clone()

virtual TTNeutralGenes* TTNeutralGenes_byte::clone ( )

inlinevirtual

Implements TTNeutralGenes.

{return new TTNeutralGenes_byte(*this);}

References TTNeutralGenes_byte().

get_allele()

unsigned int TTNeutralGenes_byte::get_allele ( int  loc, int  all  ) const

virtual

Implements TTNeutralGenes.

{
  return ( !(loc<(int)_myProto->get_locus_num()) || !(all<(int)_myProto->get_ploidy()) ? 0 : (double)_sequence[all][loc]);
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_locus_num(), and TProtoNeutralGenes::get_ploidy().

get_allele_value()

double TTNeutralGenes_byte::get_allele_value ( int  loc, int  all  ) const

virtual

Implements TTNeutralGenes.

{
  return ( !(loc<(int)_myProto->get_locus_num()) || !(all<(int)_myProto->get_ploidy()) ? 0 : (double)_sequence[all][loc]);
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_locus_num(), and TProtoNeutralGenes::get_ploidy().

get_sequence()

virtual void** TTNeutralGenes_byte::get_sequence ( ) const

inlinevirtual

Implements TTNeutralGenes.

{return (void**)_sequence;}

References _sequence.

inherit()

void TTNeutralGenes_byte::inherit ( const TTrait *  mother, const TTrait *  father  )

virtual

Implements TTNeutralGenes.

{
  const unsigned char** mother_seq = (const unsigned char**)mother->get_sequence();
  const unsigned char** father_seq = (const unsigned char**)father->get_sequence();
 
  (_myProto->* _inherit_func_ptr) (FEM, _sequence[FEM], mother_seq);
 
  (_myProto->* _inherit_func_ptr) (MAL, _sequence[MAL], father_seq);
}

References _inherit_func_ptr, TTNeutralGenes::_myProto, _sequence, FEM, TTrait::get_sequence(), and MAL.

init()

void TTNeutralGenes_byte::init ( )

virtual

Implements TTNeutralGenes.

{
  if(_sequence != NULL)
    fatal("TTNeutralGenes::init::_sequence is not NULL !\n");
 
  //assume _ploidy = 2;
 
  _sequence = new unsigned char* [2];
 
  _sequence[0] = new unsigned char[_myProto->get_locus_num()];
  _sequence[1] = new unsigned char[_myProto->get_locus_num()];
 
  memset(_sequence[0], 1, _myProto->get_locus_num());
  memset(_sequence[1], 1, _myProto->get_locus_num());
 
}

References TTNeutralGenes::_myProto, _sequence, fatal(), and TProtoNeutralGenes::get_locus_num().

Referenced by operator=(), and set_sequence().

init_sequence()

void TTNeutralGenes_byte::init_sequence ( )

virtual

Implements TTNeutralGenes.

{
  if(_sequence == NULL) { //that should never happen
    _sequence = new unsigned char* [_myProto->get_ploidy()];
    for(unsigned int i = 0; i < _myProto->get_ploidy(); i++)
      _sequence[i] = new unsigned char[_myProto->get_locus_num()];
  }
 
  if(_myProto->get_init_model() == 1) {
    for(unsigned int i = 0; i < _myProto->get_ploidy(); ++i)
      for(unsigned int j = 0; j < _myProto->get_locus_num(); j++) {
 
        if(_myProto->get_allele_num() > 2)
          _sequence[i][j] = (unsigned char)RAND::Uniform(_myProto->get_allele_num());
        else
          _sequence[i][j] = (unsigned char)RAND::Bernoulli(0.5);
      }
  } else if (_myProto->get_init_model() == 3 ) {
 
    memset(_sequence[0], 0, _myProto->get_locus_num());
    memset(_sequence[1], 0, _myProto->get_locus_num());
 
    mutate(); //do one round of mutation
 
  } else { //model 0; all monomorphic
 
    memset(_sequence[0], 0, _myProto->get_locus_num());
    memset(_sequence[1], 0, _myProto->get_locus_num());
 
  }
}

References TTNeutralGenes::_myProto, _sequence, RAND::Bernoulli(), TProtoNeutralGenes::get_allele_num(), TProtoNeutralGenes::get_init_model(), TProtoNeutralGenes::get_locus_num(), TProtoNeutralGenes::get_ploidy(), mutate(), and RAND::Uniform().

mutate()

virtual void TTNeutralGenes_byte::mutate ( )

inlinevirtual

Implements TTNeutralGenes.

{(this->*_mutate_func_ptr) ();}

References _mutate_func_ptr.

Referenced by init_sequence().

mutate_2all()

void TTNeutralGenes_byte::mutate_2all ( )

inline

{
  unsigned int mutAll, mutLocus;
  unsigned int NbMut = _myProto->get_num_mutations();
 
  for( ; NbMut > 0; NbMut--) {
    mutLocus = RAND::Uniform( _myProto->get_locus_num());
    mutAll = RAND::RandBool(); //RAND::Uniform( _ploidy); <--- only diploids for now
    _sequence[mutAll][mutLocus] = !_sequence[mutAll][mutLocus];
  }
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_locus_num(), TProtoNeutralGenes::get_num_mutations(), RAND::RandBool(), and RAND::Uniform().

Referenced by TProtoNeutralGenes::setParameters().

mutate_KAM()

void TTNeutralGenes_byte::mutate_KAM

(

)

{
  unsigned int mutAll, mutLocus;
  unsigned char mut;
  unsigned int NbMut = _myProto->get_num_mutations();
 
  for(; NbMut != 0; NbMut--) {
    mutLocus = RAND::Uniform( _myProto->get_locus_num());
    mutAll = RAND::RandBool(); //RAND::Uniform( _ploidy); <--- only diploids for now
    //assign an arbitrary allele value:
    do{
      mut = (unsigned char) (RAND::Uniform(_myProto->get_allele_num()));
    } while (mut == _sequence[mutAll][mutLocus]);
    _sequence[mutAll][mutLocus] = mut;
  }
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_allele_num(), TProtoNeutralGenes::get_locus_num(), TProtoNeutralGenes::get_num_mutations(), RAND::RandBool(), and RAND::Uniform().

Referenced by TProtoNeutralGenes::setParameters().

mutate_NULL()

void TTNeutralGenes_byte::mutate_NULL ( )

inline

{ }

Referenced by TProtoNeutralGenes::setParameters().

mutate_SSM()

void TTNeutralGenes_byte::mutate_SSM

(

)

direction && all == 0

{
  unsigned int mutAll, mutLocus;
  bool direction;
  unsigned int NbMut = _myProto->get_num_mutations();
 
  for(; NbMut != 0; NbMut--)
  {
    mutLocus = RAND::Uniform( _myProto->get_locus_num() );
    mutAll = RAND::RandBool(); //RAND::Uniform( _ploidy); <--- only diploids for now
    direction = RAND::RandBool();
    //alleles values are from 0 to NtrlAll - 1 !!!
    if(direction && _sequence[mutAll][mutLocus] < _myProto->get_allele_num()-1)
      _sequence[mutAll][mutLocus] += 1; //one step to the right
    else if(_sequence[mutAll][mutLocus] > 0) // !direction || all==_allele_num
      _sequence[mutAll][mutLocus] -= 1; //one step to the left
    else 
      _sequence[mutAll][mutLocus] += 1;
  }
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_allele_num(), TProtoNeutralGenes::get_locus_num(), TProtoNeutralGenes::get_num_mutations(), RAND::RandBool(), and RAND::Uniform().

Referenced by TProtoNeutralGenes::setParameters().

operator=()

TTNeutralGenes & TTNeutralGenes_byte::operator= ( const TTrait &  T )

virtual

Implements TTNeutralGenes.

{
  const TTNeutralGenes_byte& TN = dynamic_cast<const TTNeutralGenes_byte&> (T);
 
  if(this != &TN) {
 
    reset();
 
    init();
 
    memcpy(_sequence[0], TN._sequence[0], _myProto->get_locus_num());
    memcpy(_sequence[1], TN._sequence[1], _myProto->get_locus_num());
 
  }
 
  return *this;
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_locus_num(), init(), and reset().

reset()

void TTNeutralGenes_byte::reset ( )

virtual

Implements TTNeutralGenes.

{
  if(_sequence != NULL) {
 
    for(unsigned int i = 0; i < _myProto->get_ploidy(); i++)  delete [] _sequence[i];
 
    delete [] _sequence;
 
    _sequence = NULL;
  }
}

References TTNeutralGenes::_myProto, _sequence, and TProtoNeutralGenes::get_ploidy().

Referenced by operator=(), and set_sequence().

retrieve_data()

bool TTNeutralGenes_byte::retrieve_data ( BinaryStorageBuffer *  reader )

virtual

Implements TTNeutralGenes.

{
  for(unsigned int i = 0; i < _myProto->get_locus_num(); ++i)
    for(unsigned int j = 0; j < _myProto->get_ploidy(); ++j)
      reader->read(&_sequence[j][i], 1);
  return true;
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_locus_num(), TProtoNeutralGenes::get_ploidy(), and BinaryStorageBuffer::read().

set_allele()

void TTNeutralGenes_byte::set_allele ( unsigned int  loc, unsigned int  al, unsigned char  val  )

inline

{_sequence[al][loc] = val;}

References _sequence.

set_allele_value()

void TTNeutralGenes_byte::set_allele_value ( unsigned int  locus, unsigned int  allele, double  value  )

virtual

Implements TTNeutralGenes.

{
  assert(locus < _myProto->get_locus_num() && allele < 2);
  _sequence[allele][locus] = (unsigned char)value;
}

References _sequence.

set_inherit_func_ptr()

void TTNeutralGenes_byte::set_inherit_func_ptr ( void(TProtoNeutralGenes::*)(sex_t, unsigned char *, const unsigned char **)  theFunc )

inline

  {_inherit_func_ptr = theFunc;}

References _inherit_func_ptr.

Referenced by TProtoNeutralGenes::hatch().

set_mut_func_ptr()

void TTNeutralGenes_byte::set_mut_func_ptr ( void(TTNeutralGenes_byte::*)(void)  theFunc )

inline

  {_mutate_func_ptr = theFunc;}

References _mutate_func_ptr.

Referenced by TProtoNeutralGenes::hatch().

set_sequence()

void TTNeutralGenes_byte::set_sequence ( void **  seq )

virtual

Implements TTNeutralGenes.

{
  reset(); init();
  memcpy(_sequence[0],seq[0],_myProto->get_locus_num());
  memcpy(_sequence[1],seq[1],_myProto->get_locus_num());
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_locus_num(), init(), and reset().

show_up()

void TTNeutralGenes_byte::show_up ( )

virtual

Implements TTNeutralGenes.

{
  message("\n  Trait's type: ntrl\n\
       locus: %i\n\
     alleles: %i\n\
    _sequence:",_myProto->get_locus_num(), _myProto->get_allele_num());
 
  for(unsigned int i = 0; (i < _myProto->get_locus_num() && i < 10); i++)
    message("\n              %i %i",(int)_sequence[0][i],(int)_sequence[1][i]);
  if(_myProto->get_locus_num() > 10) message("\n              ...");
  message("\n");
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_allele_num(), TProtoNeutralGenes::get_locus_num(), and message().

store_data()

void TTNeutralGenes_byte::store_data ( BinaryStorageBuffer *  saver )

virtual

Implements TTNeutralGenes.

{
  for(unsigned int i = 0; i < _myProto->get_locus_num(); ++i)
    for(unsigned int j = 0; j < _myProto->get_ploidy(); ++j)
      saver->store(&_sequence[j][i], 1);
}

References TTNeutralGenes::_myProto, _sequence, TProtoNeutralGenes::get_locus_num(), TProtoNeutralGenes::get_ploidy(), and BinaryStorageBuffer::store().

Member Data Documentation

_inherit_func_ptr

void(TProtoNeutralGenes::* TTNeutralGenes_byte::_inherit_func_ptr) (sex_t, unsigned char *, const unsigned char **)

private

Referenced by inherit(), and set_inherit_func_ptr().

_mutate_func_ptr

void(TTNeutralGenes_byte::* TTNeutralGenes_byte::_mutate_func_ptr) (void)

private

Referenced by mutate(), and set_mut_func_ptr().

_sequence

unsigned char** TTNeutralGenes_byte::_sequence

private

Referenced by get_allele(), get_allele_value(), get_sequence(), inherit(), init(), init_sequence(), mutate_2all(), mutate_KAM(), mutate_SSM(), operator=(), reset(), retrieve_data(), set_allele(), set_allele_value(), set_sequence(), show_up(), store_data(), and ~TTNeutralGenes_byte().

---

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

• ttneutralgenes.h
• ttneutralgenes.cc