Class Person

A person (typically a spouse or domestic partner). Birth date and sex must be specified for correct actuarial data.

Hierarchy

Item<"person">
- Person

Implements

IFPerson

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Person(row: RowType<"person">, scenario: IFScenario): Person

Overrides Item.constructor
- Defined in src/model/person.ts:26
Parameters
- row: RowType<"person">
- scenario: IFScenario
Returns Person

Properties

Private Optional #survivalProbabilities

#survivalProbabilities: Probability[]

Private Optional #temporal

#temporal: Temporal<Person> = ...

birth

birth: Date

Readonly categories

categories: Category[]

Optional Readonly end

end: boolean

expectencies

expectencies: number[]

expectency

expectency: number

Readonly id

id: string

Readonly name

name: string

Optional notes

notes: string

prettyName

prettyName: string

Readonly scenario

scenario: IFScenario

Readonly scenarios

scenarios: string[]

sex

sex: Sex

sort

sort: number

Sort order

Readonly start

start: Date

Readonly type

type: "person"

Accessors

survivalProbabilities

get survivalProbabilities(): Probability[]

- Defined in src/model/person.ts:73
An array of the probabilities of dying in the nth subsequent year.

Returns Probability[]

temporal

get temporal(): Temporal<this>
set temporal(value: Temporal<this>): void

- Defined in src/model/item.ts:58
Returns Temporal<this>
- Defined in src/model/item.ts:53
Parameters
- value: Temporal<this>
Returns void

Methods

age

age(date: Date): Age
age(year: Year): Age

Implementation of IFPerson.age
- Defined in src/model/person.ts:57
Get the fractional age on the date of interest.

Parameters
- date: Date
  
  the date of interest.
Returns Age
Implementation of IFPerson.age
- Defined in src/model/person.ts:62
Obtain the integer age reached on the birthday occurring in the specified year.

Parameters
- year: Year
  
  Year as an integer
Returns Age

hasCategory

hasCategory(category: Category): boolean

Implementation of IFPerson.hasCategory

Inherited from Item.hasCategory
- Defined in src/model/item.ts:90
Determine if an item is in a specified category.

Parameters
- category: Category
Returns boolean

iage

iage(date: Date): IAge
iage(year: Year): IAge

- Defined in src/model/person.ts:83
Obtain the integer age on a specified date. This is used for things like tax computation where the age is treated as a year-based threshold or as a table index.

Parameters
- date: Date
  
  Date of interest
Returns IAge
- Defined in src/model/person.ts:88
Obtain the integer age reached on the birthday occurring in the specified year.

Parameters
- year: Year
  
  Year as an integer
Returns IAge

inScenario

inScenario(scenario: string): boolean

Implementation of IFPerson.inScenario

Inherited from Item.inScenario
- Defined in src/model/item.ts:97
Determine if an item is in a specified scenario.

Parameters
- scenario: string
Returns boolean

states

states<T>(start: CalendarStep): Generator<IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }, any, IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }>

Implementation of IFPerson.states

Overrides Item.states
- Defined in src/model/person.ts:37
Type parameters
- T: "incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text"
Parameters
- start: CalendarStep
Returns Generator<IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }, any, IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }>

Static inScenario

inScenario(scenario: string, scenarios: string[] | IItem<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">): boolean

Inherited from Item.inScenario
- Defined in src/model/item.ts:101
Parameters
- scenario: string
- scenarios: string[] | IItem<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">
Returns boolean

Generated using TypeDoc