The Data Space#
Input data shared by every by-policy projection.
The eight input CSVs are read here, once per model, and referenced from
Projection as data. Projection is
parameterized by idx, the position of a model point in the table, so each
Projection[i] is a separate ItemSpace with its own cells cache; if the readers lived
there, every model point would re-read every file. Holding them in an unparameterized
Space reads each file once no matter how many policies are projected.
Inputs are external files: plain CSVs in the model folder’s parent directory,
products/universal_life/, rather than data stored inside the model. The model
folder therefore holds nothing but formulas – no _data/, no IOSpec, no embedded
values – so a diff of the model shows logic changes only. This follows
annuallife.TradLife_A; contrast basiclife.BasicTerm_S, which keeps its inputs
inside the model through modelx’s IOSpec machinery.
The consequence worth knowing: the model is not portable on its own. Copying the
UL_US_SEC folder without its parent’s CSVs produces a model that reads and
then fails on first evaluation.
Seven of the tables are UL_US_S’s. The guaranteed COI scale, the corridor factors,
the mortality table, the class factors, the lapse table, the premium persistency scale
and the surrender charge schedules are the files UL_US_S reads, read here in
place: one copy of each table serves both models, so an edit to one reaches both. The
model point table is this model’s own, model_point_table_sec.csv; it sits beside
UL_US_S’s model_point_table.csv, which this model never opens.
input_dir() resolves the directory from _model.path.parent at run time, so
the model works wherever the repository is checked out. Each table has a filename
Reference and a reader Cells:
Reference |
Cells |
File |
|---|---|---|
model_point_file |
model_point_table() |
model_point_table_sec.csv |
coi_rates_file |
coi_rates() |
coi_rates.csv |
corridor_file |
corridor_factors() |
corridor_factors.csv |
mort_table_file |
mort_table() |
mort_table.csv |
class_factor_file |
class_factor_table() |
class_factor_table.csv |
lapse_table_file |
lapse_table() |
lapse_table.csv |
prem_persistency_file |
prem_persistency_table() |
prem_persistency.csv |
surr_charge_file |
surr_charge_table() |
surr_charge_table.csv |
The model point table is checked as it is read. Eight of its columns are the
in-force interface: policy_count and duration_mth, as in
basiclife.BasicTerm_SE, and the six columns of an in-force policy’s opening state.
model_point_table() refuses a table that lacks any of them, repeats a
point_id, holds a count or a duration no policy can have, or holds an opening state
no policy can be in. The checks run in turn, and the first that fails raises, naming the
missing column or every point that fails it. It also refuses a policy to be issued more
than future_horizon_mth months after the valuation date, 120 months as shipped:
future new business is written over a stated horizon, so that no frame runs longer than
the projection from issue plus that horizon. Set to 0, the Reference refuses future new
business altogether. A longer horizon projects in modelx, but the compiled model’s
caches are sized for the shipped 120 months (spec_sec.py): it needs t there raised
to 12 x (omega_age - issue_age_min + 1) + the horizon + 2 and a rebuild, or a frame
longer than 1,356 months raises IndexError compiled, naming nothing, at the first
month past the caches. Whether a point is still inside the projection at the valuation
date, and whether the contract issues it, are rules of the product rather than of the
table, and Projection.proj_len checks them, against two Projection References the
caches are sized from as they are from the horizon: omega_age and
issue_age_min.
The table is checked, too, wherever a projection reads a column as a number: each value
of the contract, the face, the premiums, the withdrawal, the load and the tax limits’
inputs, must be a number in the range the quantity can take, the surrender-charge flag
True or False, and the issue age a finite number (model_point_table()).
So are the seven assumption tables. Each table read at a policy year or an attained
age has one reader in Projection, keyed by the year or the age, and that reader takes
the table’s extent – the last policy year, or the first and last ages, beyond which it
reads the nearest row – from a cell here that reads the key column by value, once, and
checks the table: prem_persistency_last_year(), lapse_last_year(),
corridor_age_first() and corridor_age_last(), mort_age_first() and
mort_age_last(), and, for the COI scale, whose issue-age cells are numbered as
schedules, coi_schedules(), which every COI vector asks first. A key that is
blank, text or not a whole number is refused, naming the file, the column and the lines
it is on, and so is a negative age, since an age table is held from age 0. So are keys
that do not run one row a year or an age, without a gap or a repeat, policy years from
1, the message naming each key that repeats, with its lines, and each that is missing.
And so is a rate that is blank, text or infinite, naming the column and its lines.
class_count() and surr_charge_count() check the class factors and the
surrender-charge schedules the same way, for the joins that read them,
class_factor(), surr_charge_rate_max(), surr_charge_runoff_years()
and has_surr_charge_schedule(). Each reader and each join asks for its extent, or
the count, before it reads a value, so a projection meets the checks first.
UL_US_S’s readers take the extent from the key column as pandas reads it, where a blank
key is a missing value the extent skips: the table is cut short, and every later year reads
the last good row, without a word. A blank rate is a missing value to it too, which shows
in its flows or is lost in a min or a max: a blank lapse rate reads as the cap of
35%, a blank corridor factor as no corridor and a blank surrender charge as none. Here
a blank rate or class factor would make the mortality rate a missing value, as in
UL_US_S, and every flow after it, so each is refused, by name.
coi_rates.csv carries the guaranteed maximum monthly rate per $1,000 of net
amount at risk; the current scale is the guaranteed scale times
Projection.coi_curr_factor, because current COI scales are not published [std].
mort_table.csv is a small illustrative best-estimate table [std], not a
published one – the notes forbid hard-coding the licensed 2015 VBT and 2017 CSO
families. To swap in a licensed basis, replace the file with a same-schema one, or
point mort_table_file at a different name before the model computes anything: a
compiled model clears no cache, so there the name is set on a package just imported,
before anything is read. No formula changes. Replacing the file changes
UL_US_S too, which reads the same one.
The vectors. The readers return what the files hold, and no
Projection cell but model_point, a reporting cell, reads them. The
others read the arrays below instead, one element at a time, a model point’s attribute
being the element at its position, data.sum_assured()[idx]. That is what lets the
model compile to C, as basiclife.BasicTerm_SC does: each array is a numpy vector or
table of int64 or float64, which compiles to a typed memoryview, never one of bools,
objects or text, and each count of schedules is an int.
Text the projection needs is decoded here, into the number it selects: each value of the death benefit option, the qualification test and the premium pattern a monthly cell branches on into a 0/1 flag, and the surrender-charge flag into another. Each table keyed by more than a number becomes an integer-indexed array or a join. The COI scales, keyed by sex, class and issue age, are numbered, each point carrying the number of its own, and tabled by schedule and policy year. The persistency and lapse tables are held by policy year, and the corridor and mortality tables by attained age, each padded from 0, so that the year or the age is the index. The class factor and the surrender-charge schedule, each one number a point, are joined to the points:
Cells |
dtype |
Shape |
From |
|---|---|---|---|
point_id() |
int64 |
[point] |
the table’s index |
age_at_entry() |
int64 |
[point] |
|
duration_mth() |
int64 |
[point] |
|
sum_assured() |
float64 |
[point] |
|
policy_count() |
float64 |
[point] |
|
premium_pp_ann() |
float64 |
[point] |
|
wd_pp() |
float64 |
[point] |
|
load_prem_rate() |
float64 |
[point] |
|
gsp() |
float64 |
[point] |
|
glp() |
float64 |
[point] |
|
seven_pay_prem() |
float64 |
[point] |
|
av_pp_init() |
float64 |
[point] |
|
loan_bal_init() |
float64 |
[point] |
|
sum_assured_init() |
float64 |
[point] |
|
wd_used_year_init() |
float64 |
[point] |
|
cum_prem_init() |
float64 |
[point] |
|
is_mec_init() |
int64 |
[point] |
|
has_surr_charge() |
int64 |
[point] |
|
is_db_option_a() |
int64 |
[point] |
|
is_db_option_b() |
int64 |
[point] |
|
is_gpt() |
int64 |
[point] |
|
is_level_premium() |
int64 |
[point] |
|
is_single_premium() |
int64 |
[point] |
|
is_target_premium() |
int64 |
[point] |
|
class_factor() |
float64 |
[point] |
class_factor_table.csv, joined |
surr_charge_rate_max() |
float64 |
[point] |
surr_charge_table.csv, joined |
surr_charge_runoff_years() |
float64 |
[point] |
surr_charge_table.csv, joined |
has_surr_charge_schedule() |
int64 |
[point] |
the same, 1 where the table holds the id |
coi_schedules() |
int |
scalar |
coi_rates.csv, checked |
coi_schedule() |
int64 |
[point] |
sex, class and issue age, joined; 0 where not |
coi_rate_last_years() |
int64 |
[point] |
coi_rates.csv, by schedule |
coi_rate_array() |
float64 |
[schedule, y] |
coi_rates.csv |
prem_persistency_array() |
float64 |
[y] |
prem_persistency.csv |
lapse_rate_array() |
float64 |
[y] |
lapse_table.csv |
corridor_factor_array() |
float64 |
[age] |
corridor_factors.csv |
mort_table_array() |
float64 |
[age] |
mort_table.csv |
The table checks are the ints they were: prem_persistency_last_year(),
lapse_last_year(), the four age extents, class_count() and
surr_charge_count().
An array is read by element, never whole, in this Space as in
Projection. The compiler types an array cell as a memoryview only once
it has seen that every use of it, in either Space, is an element read: one len(),
slice, loop over it or numpy call on it anywhere, and the cell compiles as a Python
object. So an array derived here from another reads the table’s column, or the other
cell element by element, and a width comes from a table, never from another cell’s array.
Each table’s check is one cell that every array, extent and schedule number of the table
reads first, coi_schedules() for the COI scale, so that a projection, which reads
an extent or a schedule number first, meets the same refusal as a reader of the array.
The column keywords of a DataFrame.assign are passed as **{...}, since a keyword
named as a cell of this Space, age_at_entry, would be rewritten by the export.
What cannot be decoded or joined is refused when the array is first read, naming
every point at fault: a point_id that is not a whole number; a rate_class the
class factors lack, and on a point that has_surr_charge a surr_charge_id the
schedules lack, a run-off of 0 years, which the charge’s run-off divides by, or a run-off
of 2**53 years or more in size (below). UL_US_S fails every projection of a point
whose class or charged schedule the tables lack, or whose run-off is 0, since it reads its
class factor in every month on the books, and its schedule in every month of a point with
a charge. It projects a run-off of 2**53 years or more, which is refused for the
compiled int() of it (below). A point without a charge is never refused for its
schedule, whatever its id, as UL_US_S never reads it: its schedule is read where the
table holds its id, and where it does not, Projection.surr_charge_rate_max raises
KeyError, as at stage E. A point whose COI cell the
scale lacks is another matter: it reads its scale only while charges run, and a point
valued or issued at or past charges_cease_age never does, so UL_US_S projects it.
It is given schedule 0, and Projection.coi_rate_last_year refuses it, naming it, where
a rate is read. A value of db_option, qual_test or premium_type none of the
flags names is no flag, and the cell that branches on them raises UL_US_S’s message,
as in UL_US_S. A read beyond a table’s extent is refused where UL_US_S’s lookup
raised KeyError, by the one Projection cell that reads the table,
naming the point: a policy year below 1 in prem_persistency_py, lapse_rate_base_py
and coi_rate_guar_py. An age outside its table reads the nearest row, as in
UL_US_S, so no padding is read.
An int64 holds what it is read from. A float past int64 casts to the least int64
without a word, so a number read into an int64 vector is first refused unless it is
below 2**53 in size, where the int64 holds UL_US_S’s reading of it: the issue age
and duration_mth (model_point_table()) and the point_id (point_id()).
A charged point’s run-off is held to the same bound, though no cast is silent there: its
int(), in Projection.lapse_shock_year, compiles to a Python int converted to a C
long long, exact below 2**63 and raising OverflowError past it, where
UL_US_S projects a charge that never runs off. modelx and the compiled model refuse
alike, before any cast. A fractional issue age is not refused: it truncates toward
zero, as UL_US_S’s int truncates it.
Cells Descriptions#
- input_dir()[source]#
The directory holding the input CSVs: the model folder’s parent.
Inputs are external files, not data stored inside the model, so the model folder is pure formulas. The path is resolved at run time from where the model was read, following
annuallife.TradLife_A.
- model_point_table()[source]#
The model point table, read from model_point_table_sec.csv and checked.
Indexed by
point_id. Eight columns are the in-force interface:policy_countandduration_mth, the completed policy months at the valuation date, as inbasiclife.BasicTerm_SE, and the six columns of the opening state, per policy, as the policy stands at the start of month 0, before any month-0 event:av_pp_initandloan_bal_init: the account value and the loan entering month 0,UL_US_S’s own two columns;sum_assured_init: the face in force entering month 0, after every withdrawal cut to date;wd_used_year_init: the free withdrawal allowance already used in the policy year under way;cum_prem_init: the premiums less withdrawals paid before the valuation date;is_mec_init: the MEC latch, an int code, 1 for a policy that has already failed the 7-pay test and 0 for one that has not.
The rest are
UL_US_S’s, exceptrow_kind,source_policy_idandsource_mth, which record where the generator took each shipped row from and which no formula reads.The checks run over the whole table at once, and the first that fails raises
ValueError, naming the missing column or every point it fails on:the eight in-force columns are present, and so is every other column a projection reads:
age_at_entry,sex,rate_class,sum_assured,db_option,qual_test,premium_type,premium_pp_ann,load_prem_rate,wd_pp,has_surr_charge,surr_charge_id,gsp,glpandseven_pay_prem;no
point_idappears twice;policy_countis a number, zero or more;duration_mthis a whole number of months: positive for a policy in force, 0 for one issued at the valuation date, negative for one issued later; and below2**53months in size, where its int64 vector holds it (the Space docstring);no policy is issued more than
future_horizon_mthmonths after the valuation date, soduration_mthis-future_horizon_mthor more. At 0 the model takes no future new business, and the message says so; a negative horizon is itself refused;age_at_entryis a finite number, below2**53in size, where its int64 vector holds it. A fraction is not refused: it truncates toward zero, asUL_US_S’sinttruncates it, and an age the contract does not issue isProjection.proj_len’s to refuse;the values of the contract, each of which a projection reads as a number, through a floor, a
maxor aminincluded, are each a number in the range the quantity can take:sum_assured, the face at issue, a number above 0, which every policy holds; the planned premiumpremium_pp_ann, the planned withdrawalwd_ppand the tax limits’ inputsgsp,glpandseven_pay_prem, each a number, zero or more; andload_prem_rate, a number from 0 to 1. A blank, a text or an infinity is no such number;has_surr_chargeis True or False, as pandas reads those words in any case. Any other value, a 1, a 0 or a blank among them, would make the column numbers or text, andUL_US_S’sbool()reads the text"False"as true;the account value, the loan, the face and the year’s usage are each a number, zero or more. A balance is never negative in force.
UL_US_Slets a point’s account value fall below zero once it is in permanent shortfall, because it does not implement the grace cascade that would end such a policy; no policy in force can hold that balance, so a point in permanent shortfall is restated no later than the last month its account value is still zero or more. Without a loan that is the month its shortfall begins, as point 7 is; with one, the shortfall test, which nets the loan, fails months earlier;cum_prem_initis a number, of either sign. Premiums less withdrawals is a tax measure, not a balance, and withdrawals taken in full count against it [std];is_mec_initis 0 or 1, an int code; 1.0 reads as True;a policy not yet in force,
duration_mth0 or less, has no opening state: it is issued with none, at the facesum_assured();sum_assured_initis above 0 on a policy in force, which holds a face, so an extract that leaves the column at zero is refused rather than projected on the corridor alone;sum_assured_initis at mostsum_assured, the face at issue, since face increases are not modelled. A face below it is accepted, whether a withdrawal cut it or an elective decrease the model does not implement, and is projected from the value given;on a point valued on a policy anniversary,
duration_mtha multiple of 12,wd_used_year_initis 0: the year’s free allowance restarts there, before any usage is read, so any other value would be dropped without a word;is_mec_initis 1 where the 7-pay test has already failed in the month before the valuation date:cum_prem_initaboveseven_pay_premtimes the policy years to date, in the first seven. An earlier failure the cumulative premium no longer shows is the column’s to record, and is accepted either way.
- coi_rates()[source]#
Guaranteed maximum monthly COI rates, read from coi_rates.csv.
Per $1,000 of net amount at risk, keyed by issue-age cell and policy year.
- corridor_factors()[source]#
The GPT corridor factor table by attained age, from corridor_factors.csv.
- prem_persistency_table()[source]#
Premium persistency (paid/planned) by policy year, from prem_persistency.csv.
- surr_charge_table()[source]#
The surrender charge schedules, read from surr_charge_table.csv.
One row per
surr_charge_id, giving the initial charge per $1,000 of initial face and the number of years over which it runs off linearly.
- prem_persistency_last_year()[source]#
The last policy year prem_persistency.csv gives a factor for, the table checked.
The
policy_yearcolumn is read by value, once, as the lookup matches it, so a year written16.0is year 16. A key that is blank, text or not a whole number is refused, naming the file, the column and the lines it is on. So are policy years that do not run from 1, one row a year, without a gap or a repeat: the message names each year that repeats or falls below 1, with its lines, and each year missing from 1 to the last. And so is aprem_persistencyfactor that is blank, text or infinite, naming its lines.Projection.prem_persistency_py, the table’s one reader, takes its extent from here before it reads a factor, so a projection meets the checks first.
- lapse_last_year()[source]#
The last policy year lapse_table.csv gives a rate for, the table checked.
Read and checked as
prem_persistency_last_year()reads and checks its own table, the rate checked beinglapse_rate_ann.Projection.lapse_rate_base_py, the table’s one reader, takes its extent from here before it reads a rate.
- corridor_age_last()[source]#
The last attained age corridor_factors.csv gives a factor for, the table checked.
The
agecolumn is read by value, once, so an age written40.0is 40. A key that is blank, text or not a whole number is refused, naming the file, the column and the lines it is on, and so is a negative age, naming its lines:corridor_factor_array()holds the table from age 0, so that the age is the index, andUL_US_S, which reads the nearest row, projects such a table. So are ages that do not run one row an age, without a gap or a repeat: the message names each age that repeats, with its lines, and each age missing between the first and the last. And so is acorridor_factorthat is blank, text or infinite, naming its lines.Projection.corridor_factor_at, the table’s one reader, takes both of its extents, this andcorridor_age_first(), before it reads a factor.
- corridor_age_first()[source]#
The first attained age corridor_factors.csv gives a factor for.
Counted back from
corridor_age_last(), which checks the table’s keys first: the ages run one row an age, so the first is the last less the rows after it.
- mort_age_last()[source]#
The last attained age mort_table.csv gives a rate for, the table checked.
Read and checked as
corridor_age_last()reads and checks its own table, a negative age refused as there, sincemort_table_array()holds the table from age 0, the rate checked beingmort_rate.Projection.mort_rate_base_at, the table’s one reader, takes both of its extents, this andmort_age_first(), before it reads a rate. A blank rate is a missing value toUL_US_S, whose mortality is then not a number, and toProjection.mort_rate, whose cap,min(q, 1.0), keeps it missing.
- mort_age_first()[source]#
The first attained age mort_table.csv gives a rate for.
Counted back from
mort_age_last(), which checks the table’s keys first, ascorridor_age_first()counts its own.
- coi_schedules()[source]#
The number of issue-age cells coi_rates.csv gives a scale for, the table checked.
One schedule a cell, each
sex,rate_classandage_at_entrythe table holds:coi_rate_array()holds each schedule in a row, numbered from 1 in the order of those keys, andcoi_schedule()gives each point its number. The table’s one check, which each of them, andcoi_rate_last_years(), asks first. The two text keys may not be blank, and the two numeric keys,age_at_entryandpolicy_year, are read by value, once: a key that is blank, text or not a whole number is refused, naming the file, the column and the lines it is on. So is a cell whose policy years do not run from 1, one row a year, without a gap or a repeat: the message names the cell, each year that repeats or falls below 1, with its lines, and each year missing from 1 to the last. And so is acoi_rate_guarthat is blank, text or infinite, naming its lines.Projection.coi_rate_last_yeartakes a point’s extent fromcoi_rate_last_years()beforeProjection.coi_rate_guar_pyreads its scale, so a projection meets the checks first.
- class_count()[source]#
The number of classes class_factor_table.csv gives a factor for, the table checked.
A
rate_classthat is blank is refused, naming the file and the lines it is on, and so is one on more than one row, naming each such class with its lines; and so is afactorthat is blank, text or infinite, naming its lines.Projection.class_factor, the table’s one reader, asks for the count before it reads a factor, so a projection meets the checks first. A blank factor is a missing value toUL_US_S, whose mortality is then not a number, and toProjection.mort_rate, whose cap,min(q, 1.0), keeps it missing.
- surr_charge_count()[source]#
The number of schedules surr_charge_table.csv gives, the table checked.
A
surr_charge_idthat is blank is refused, naming the file and the lines it is on, and so is one on more than one row, naming each such schedule with its lines; and so is asc_per_1000_initor arunoff_yearsthat is blank, text or infinite, naming the column and its lines.Projection.surr_charge_rate_maxandProjection.surr_charge_runoff_years, the table’s two readers, ask for the count before they read a value, so a projection meets the checks first. A blank charge is a missing value toUL_US_S, whose surrender charge rate, themaxof 0 and the charge left, is then 0 in every month, as though the schedule had run off.
- coi_schedule()[source]#
The number of each model point’s guaranteed COI scale, in table order: int64 [point].
The point’s row of
coi_rate_array(): the schedules of coi_rates.csv, one for eachsex,rate_classandage_at_entryit holds, numbered from 1 in the order of those keys, ascoi_rate_array()numbers its rows, whatever the order of the file’s lines. The point’s key is itssex, itsrate_classandintof itsage_at_entry, asUL_US_Sslices the scale. A point whose key the table lacks gets schedule 0, a row of padding, and is not refused here:UL_US_Sprojects such a point while it reads no COI rate, as one valued, or issued, at or pastcharges_cease_agenever does, andProjection.coi_rate_last_yearrefuses it, naming it, when one is read. Askscoi_schedules()first, which checks the table.
- coi_rate_last_years()[source]#
The last policy year of each model point’s guaranteed COI scale: int64 [point].
The last
policy_yearcoi_rates.csv holds for the point’s schedule, numbered ascoi_schedule()numbers it, read by value oncecoi_schedules()has checked the table: 87 on the shipped anchor cell. 0 for a point the table has no scale for, schedule 0, whichProjection.coi_rate_last_yearrefuses where it is read.
- coi_rate_array()[source]#
The guaranteed maximum monthly COI rates by schedule and policy year: float64 [schedule, y].
Row
sis schedulesof coi_rates.csv, numbered from 1 in the order of its keys,sex,rate_classandage_at_entry, ascoi_schedule()numbers it, and columnyis policy yeary, so that the year is the index: one more column than the table’s last policy year, one more row than its schedules. Per $1,000 of net amount at risk. NaN in row 0, schedule 0, which no point the table holds is given, in column 0, before any policy year, and past each schedule’s last year, all padding, whichProjection.coi_rate_guar_pynever reads: it refuses a year below 1 and a point of schedule 0, and reads a later year at the schedule’s last. Askscoi_schedules()first, which checks the table.
- prem_persistency_array()[source]#
The premium persistency factors by policy year: float64 [y].
Element
yis theprem_persistencyof policy yearyin prem_persistency.csv, so that the year is the index, to the last yearprem_persistency_last_year()gives once it has checked the table. NaN at 0, before the first year, whichProjection.prem_persistency_pynever reads.
- lapse_rate_array()[source]#
The base annual lapse rates by policy year: float64 [y].
Element
yis thelapse_rate_annof policy yearyin lapse_table.csv, held asprem_persistency_array()holds its own table, to the last yearlapse_last_year()gives. NaN at 0, whichProjection.lapse_rate_base_pynever reads.
- corridor_factor_array()[source]#
The GPT corridor factors by attained age: float64 [age].
Element
ais thecorridor_factorof ageain corridor_factors.csv, so that the age is the index, to the last agecorridor_age_last()gives once it has checked the table, which refuses a negative age. NaN from 0 to below the first age, whichProjection.corridor_factor_atnever reads: it reads an age outside the table at the nearest row, asUL_US_Sdoes.
- mort_table_array()[source]#
The best-estimate annual mortality rates by attained age: float64 [age].
Element
ais themort_rateof ageain mort_table.csv, held ascorridor_factor_array()holds its own table, to the last agemort_age_last()gives. NaN from 0 to below the first age, whichProjection.mort_rate_base_atnever reads.
- point_id()[source]#
The
point_idof every model point, in table order: int64 [point].Projectionis indexed by position,idx, so this is how a projection names its point:Projection.point_id()is the element atidx, and every refusal quotes it. A label that is not a whole number is refused, naming every such label, and so is one of2**53or more in size, which numpy would read as the least int64 once past int64. pandas reads a column of whole labels as int64 exactly, so the bound refuses some labels the vector could hold, none of them a label a table needs.
- age_at_entry()[source]#
The issue age (ANB) of every model point: int64 [point].
The
age_at_entrycolumn, whichmodel_point_table()holds to a finite number below2**53in size, read asUL_US_Sreads it,intof the number: a fraction truncates toward zero, so 35.5 projects as 35.
- duration_mth()[source]#
The completed policy months at the valuation date of every model point: int64 [point].
The
duration_mthcolumn, whichmodel_point_table()holds to a whole number of months below2**53in size.
- sum_assured()[source]#
The face at issue of every model point: float64 [point].
The
sum_assuredcolumn, whichmodel_point_table()holds to a number above 0.
- policy_count()[source]#
The policies each model point stands for: float64 [point].
The
policy_countcolumn, whichmodel_point_table()holds to a number, zero or more.
The planned annual premium per policy of every model point: float64 [point].
The
premium_pp_anncolumn, whichmodel_point_table()holds to a number, zero or more.
- wd_pp()[source]#
The planned monthly withdrawal per policy of every model point: float64 [point].
The
wd_ppcolumn, whichmodel_point_table()holds to a number, zero or more.Projection.wd_pp_mthreads it, sinceProjection.wd_ppis the month’s withdrawal.
- load_prem_rate()[source]#
The current premium load rate of every model point: float64 [point].
The
load_prem_ratecolumn, whichmodel_point_table()holds to a number from 0 to 1.
- gsp()[source]#
The guideline single premium of every model point: float64 [point].
The
gspcolumn, whichmodel_point_table()holds to a number, zero or more.
- glp()[source]#
The guideline level premium of every model point: float64 [point].
The
glpcolumn, whichmodel_point_table()holds to a number, zero or more.
- seven_pay_prem()[source]#
The 7-pay premium of every model point: float64 [point].
The
seven_pay_premcolumn, whichmodel_point_table()holds to a number, zero or more.
- av_pp_init()[source]#
The account value per policy entering month 0: float64 [point].
The
av_pp_initcolumn of the opening state, checked bymodel_point_table().
- loan_bal_init()[source]#
The loan per policy entering month 0: float64 [point].
The
loan_bal_initcolumn of the opening state, checked bymodel_point_table().
- sum_assured_init()[source]#
The face in force entering month 0: float64 [point].
The
sum_assured_initcolumn of the opening state, checked bymodel_point_table().
- wd_used_year_init()[source]#
The free withdrawal allowance used in the policy year under way: float64 [point].
The
wd_used_year_initcolumn of the opening state, checked bymodel_point_table().
- cum_prem_init()[source]#
The premiums less withdrawals per policy before the valuation date: float64 [point].
The
cum_prem_initcolumn of the opening state, checked bymodel_point_table().
- is_mec_init()[source]#
The MEC latch entering month 0: int64 [point].
The
is_mec_initcolumn of the opening state, whichmodel_point_table()holds to 0 or 1, so a 1.0 reads as 1.
- has_surr_charge()[source]#
Whether a surrender charge schedule applies to each model point: int64 [point].
1 where the
has_surr_chargecolumn reads True, in any case, and 0 where it reads False:model_point_table()refuses any other value.
- is_db_option_a()[source]#
Whether each model point’s death benefit is Option A: int64 [point].
1 where
db_optionis"A", compared element by element asUL_US_Scompares it, and 0 elsewhere. A value neither A nor B is not refused here: it is no flag, andProjection.db_ppraisesUL_US_S’s message on it.
- is_db_option_b()[source]#
Whether each model point’s death benefit is Option B: int64 [point].
1 where
db_optionis"B", asis_db_option_a()decodes A.
- is_gpt()[source]#
Whether each model point elected the Guideline Premium Test: int64 [point].
1 where
qual_testis"GPT", and 0 elsewhere, whereProjection.corridor_factorraisesUL_US_S’s message.
Whether each model point’s premium pattern is LEVEL: int64 [point].
1 where
premium_typeis"LEVEL", and 0 elsewhere. A pattern none of the three is no flag, andProjection.premium_ppraisesUL_US_S’s message on it.
Whether each model point’s premium pattern is SINGLE: int64 [point].
1 where
premium_typeis"SINGLE", asis_level_premium()decodes LEVEL.
Whether each model point’s premium pattern is TARGET: int64 [point].
1 where
premium_typeis"TARGET", asis_level_premium()decodes LEVEL.
- class_factor()[source]#
The underwriting-class factor of each model point: float64 [point].
The
factorclass_factor_table.csv gives the point’srate_class, onceclass_count()has checked the table. A point reads its class factor in every month on the books, soUL_US_Sfails every projection of a point whose class the table lacks: such a point is refused here, at the first read, naming every such point.
- surr_charge_rate_max()[source]#
The surrender charge per $1,000 of initial face of each model point, before any of it runs off: float64 [point].
The
sc_per_1000_initof the point’ssurr_charge_idin surr_charge_table.csv, oncesurr_charge_count()has checked the table, on every point whose id the table holds, with a charge or without, asUL_US_SEC’s accessor read it at stageE: a point without a charge reads its schedule, though no cell reads it there. On a point without a charge whose id the table lacks, blank included, it is NaN, andhas_surr_charge_schedule()0: the point projects, andProjection.surr_charge_rate_maxraisesKeyErroron it, as the.locdid at stageE. The join refuses, naming every such point with a charge, and only on a point with one, sinceUL_US_Sreads the schedule in every month of such a point’s cover: an id the table lacks, whereUL_US_S’s.locraisedKeyError; arunoff_yearsof 0, whichProjection.surr_charge_ratedivides by; and one of2**53years or more in size, the bound of every number read as an int, past which the compiledint()inProjection.lapse_shock_yearwould in time raiseOverflowError. The same checks run insurr_charge_runoff_years(), the join’s other vector, so that whichever a projection reads first refuses the point.
- surr_charge_runoff_years()[source]#
The run-off, in policy years, of each model point’s surrender charge: float64 [point].
The
runoff_yearsof the point’ssurr_charge_idin surr_charge_table.csv, on every point whose id the table holds, NaN on a point without a charge whose id it lacks, joined and checked assurr_charge_rate_max()joins and checks the charge, with its refusals. A point without a charge reads the run-off as written, 0 or2**53years included, which no cell reads there.
- has_surr_charge_schedule()[source]#
Whether surr_charge_table.csv holds each model point’s schedule: int64 [point].
1 where the point’s
surr_charge_idis asurr_charge_idof the table, compared exactly, asUL_US_S’s.loccompares it, and 0 where it is not, blank included, oncesurr_charge_count()has checked the table. 0 only on a point without a charge, sincesurr_charge_rate_max()refuses the table where a point with a charge names an id it lacks: thereProjection.surr_charge_rate_maxandProjection.surr_charge_runoff_yearsraiseKeyError, naming the point.