pop.model
Class Fertility

java.lang.Object
  |
  +--pop.model.PopulationCharacteristics
        |
        +--pop.model.Fertility

public class Fertility
extends PopulationCharacteristics

Age-specific fertility rates, including the proportion of births that are females.


Constructor Summary
Fertility(double[] rates, double proportion_female)
          Basic constructor (one set of fertility rates, and a female-birth proportion).
 
Method Summary
 int maximum_fertile_age()
          Returns maximum fertile age.
 int minimum_fertile_age()
          Returns minimum fertile age.
 double proportion_female_births()
          Returns proportion of total births resulting in female children.
 double rate(int age)
          Returns age-specific fertility rate.
 double[] rates()
          Returns age-array of fertility rates.
 void set_proportion_female_births(double value)
          Sets proportion of births that are females to parameter value.
 void set_rates(double[] rates)
          Sets all fertility rates to values of input array.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fertility

public Fertility(double[] rates,
                 double proportion_female)
Basic constructor (one set of fertility rates, and a female-birth proportion). precondition: length of input array matches current model dimension.
Parameters:
rates - - array of fertility rates by age.
proportion_female - - proportion of births that will be females (0 to 1).
Method Detail

rate

public double rate(int age)
Returns age-specific fertility rate.
Parameters:
age - - 0 to maximum cohort age.

rates

public double[] rates()
Returns age-array of fertility rates.

proportion_female_births

public double proportion_female_births()
Returns proportion of total births resulting in female children.

minimum_fertile_age

public int minimum_fertile_age()
Returns minimum fertile age.

maximum_fertile_age

public int maximum_fertile_age()
Returns maximum fertile age.

set_rates

public void set_rates(double[] rates)
Sets all fertility rates to values of input array. Also sets minimum and maximum fertile ages. precondition: length of input array matches current model dimension.
Parameters:
rates - - array of fertility rates by age.

set_proportion_female_births

public void set_proportion_female_births(double value)
Sets proportion of births that are females to parameter value.