Clair::Network::Generator

GeneratorBase


SummaryPackage variablesSynopsisDescriptionGeneral documentationMethods

SummaryTop
Clair::Network::Generator::GeneratorBase - Network generator abstract class

Package variablesTop
No package variables defined.

Included modulesTop
Carp
Clair::Network
Math::Random

SynopsisTop
This is an abstract class for network generators. Use one of the subclasses.

DescriptionTop
A standard interface for generating networks such as Erdos-Renyi random
networks.

MethodsTop
generateDescriptionCode
get_random_uniformDescriptionCode
get_random_uniform_integerDescriptionCode
newNo descriptionCode

Methods description


generatecode    nextTop
Override this method in your subclass. It should return a new
Clair::Network object.

get_random_uniformcodeprevnextTop
Method to return a random number between 0 and 1 from a uniform distribution

get_random_uniform_integercodeprevnextTop
Method to return a random integer from a uniform distribution

Methods code


generatedescriptionprevnextTop
sub generate {
  croak "Generator sublcass must implement generate method\n";
  return;
}

get_random_uniformdescriptionprevnextTop
sub get_random_uniform {
  my $self = shift;

  return random_uniform(@_);
}

get_random_uniform_integerdescriptionprevnextTop
sub get_random_uniform_integer {
  my $self = shift;

  return random_uniform_integer(@_);
}

newdescriptionprevnextTop
sub new {
  my $class = shift;

  my $self = {};
  bless($self, $class);

  return $self;
}

General documentation


No general documentation available.