pop.data
Class InitialPopulationArray

java.lang.Object
  |
  +--pop.data.InitialPopulationArray

public class InitialPopulationArray
extends java.lang.Object
implements PopulationSizesFactory

Creates array of PopulationSizes as copies or from int arrays.

See Also:
Serialized Form

Constructor Summary
InitialPopulationArray(int[][][] x)
          Basic constructor copies a 3-dimensional array: [Statics.categories()][2][Statics.maximum_age()+1].
InitialPopulationArray(PopulationSizes[] sizes)
          Handy constructor based on array of PopulationSizes.
 
Method Summary
 PopulationCharacteristics get_characteristics(int category)
          Returns a new PopulationSizes object for the indicated population category.
 PopulationCharacteristics get_characteristics(java.lang.String category)
          Returns a new PopulationSizes object for the indicated population category.
 PopulationSizes population_sizes(int category)
          Returns a new PopulationSizes object for the indicated population category.
 PopulationSizes population_sizes(java.lang.String category)
          Returns a new PopulationSizes object for the indicated population category.
 boolean ready()
          Simply returns true at present.
 int[][] sizes(int category)
          Returns handle to array of population sizes for the indicated population category.
 int[][] sizes(java.lang.String category)
          Returns handle to array of population sizes for the indicated population category.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InitialPopulationArray

public InitialPopulationArray(int[][][] x)
Basic constructor copies a 3-dimensional array: [Statics.categories()][2][Statics.maximum_age()+1].

InitialPopulationArray

public InitialPopulationArray(PopulationSizes[] sizes)
Handy constructor based on array of PopulationSizes. preconditions: input array dimensions match current model.
Parameters:
sizes - - the array of PopulationSizes (one for each population category in the current model).
Method Detail

population_sizes

public PopulationSizes population_sizes(int category)
Returns a new PopulationSizes object for the indicated population category. precondition: category is valid.
Specified by:
population_sizes in interface PopulationSizesFactory

population_sizes

public PopulationSizes population_sizes(java.lang.String category)
Returns a new PopulationSizes object for the indicated population category. precondition: category is valid.
Specified by:
population_sizes in interface PopulationSizesFactory

get_characteristics

public PopulationCharacteristics get_characteristics(int category)
Returns a new PopulationSizes object for the indicated population category. precondition: category is valid.

get_characteristics

public PopulationCharacteristics get_characteristics(java.lang.String category)
Returns a new PopulationSizes object for the indicated population category. precondition: category is valid.

sizes

public int[][] sizes(int category)
Returns handle to array of population sizes for the indicated population category. First dimension of array is sex (with females in the first row, males second row) and second dimension is age. precondition: category is valid for the current model.

sizes

public int[][] sizes(java.lang.String category)
Returns handle to array of population sizes for the indicated population category. First dimension of array is sex (with females in the first row, males second row) and second dimension is age. precondition: category is valid for the current model.

ready

public boolean ready()
Simply returns true at present.