3. API Reference

• 3.1. Underwriter Module
  • 3.1.1. Underwriter Class
    • 3.1.1.1. Underwriter
      • 3.1.1.1.1. Underwriter.__init__()
      • 3.1.1.1.2. Underwriter._interpreter_work()
      • 3.1.1.1.3. Underwriter.build()
      • 3.1.1.1.4. Underwriter.dir()
      • 3.1.1.1.5. Underwriter.factory()
      • 3.1.1.1.6. Underwriter.interpret_program()
      • 3.1.1.1.7. Underwriter.interpreter_file()
      • 3.1.1.1.8. Underwriter.interpreter_line()
      • 3.1.1.1.9. Underwriter.interpreter_list()
      • 3.1.1.1.10. Underwriter.logger_level()
      • 3.1.1.1.11. Underwriter.more()
      • 3.1.1.1.12. Underwriter.qlist()
      • 3.1.1.1.13. Underwriter.qshow()
      • 3.1.1.1.14. Underwriter.read_database()
      • 3.1.1.1.15. Underwriter.run_test_suite()
      • 3.1.1.1.16. Underwriter.safe_lookup()
      • 3.1.1.1.17. Underwriter.show()
      • 3.1.1.1.18. Underwriter.test_suite_file
      • 3.1.1.1.19. Underwriter.write()
      • 3.1.1.1.20. Underwriter.write_from_file()
  • 3.1.2. Other Underwriter functions
• 3.2. Parser Module
  • 3.2.1. Lexer Class
    • 3.2.1.1. UnderwritingLexer
      • 3.2.1.1.1. UnderwritingLexer.preprocess()
  • 3.2.2. Parser Class
    • 3.2.2.1. UnderwritingParser
      • 3.2.2.1.1. UnderwritingParser.enhance_debugfile()
      • 3.2.2.1.2. UnderwritingParser.error()
  • 3.2.3. Remaining Functions
    • 3.2.3.1. grammar()
• 3.3. Distributions Module
  • 3.3.1. Frequency Class
    • 3.3.1.1. Frequency
      • 3.3.1.1.1. Frequency.__init__()
  • 3.3.2. Severity Class
    • 3.3.2.1. Severity
      • 3.3.2.1.1. Severity.__init__()
      • 3.3.2.1.2. Severity.cv_to_shape()
      • 3.3.2.1.3. Severity.mean_to_scale()
      • 3.3.2.1.4. Severity.moms()
      • 3.3.2.1.5. Severity.plot()
  • 3.3.3. Aggregate Class
    • 3.3.3.1. Aggregate
      • 3.3.3.1.1. Aggregate.__init__()
      • 3.3.3.1.2. Aggregate._apply_reins_work()
      • 3.3.3.1.3. Aggregate._reins_audit_df_work()
      • 3.3.3.1.4. Aggregate._repr_html_()
      • 3.3.3.1.5. Aggregate.aggregate_error_analysis()
      • 3.3.3.1.6. Aggregate.apply_agg_reins()
      • 3.3.3.1.7. Aggregate.apply_distortion()
      • 3.3.3.1.8. Aggregate.apply_occ_reins()
      • 3.3.3.1.9. Aggregate.approximate()
      • 3.3.3.1.10. Aggregate.cdf()
      • 3.3.3.1.11. Aggregate.cramer_lundberg()
      • 3.3.3.1.12. Aggregate.density_df
      • 3.3.3.1.13. Aggregate.describe
      • 3.3.3.1.14. Aggregate.discretize()
      • 3.3.3.1.15. Aggregate.easy_update()
      • 3.3.3.1.16. Aggregate.entropy_fit()
      • 3.3.3.1.17. Aggregate.explain_validation()
      • 3.3.3.1.18. Aggregate.freq_pmf()
      • 3.3.3.1.19. Aggregate.html_info_blob()
      • 3.3.3.1.20. Aggregate.json()
      • 3.3.3.1.21. Aggregate.limits()
      • 3.3.3.1.22. Aggregate.more()
      • 3.3.3.1.23. Aggregate.pdf()
      • 3.3.3.1.24. Aggregate.picks()
      • 3.3.3.1.25. Aggregate.plot()
      • 3.3.3.1.26. Aggregate.pmf()
      • 3.3.3.1.27. Aggregate.pollaczeck_khinchine()
      • 3.3.3.1.28. Aggregate.ppf()
      • 3.3.3.1.29. Aggregate.pprogram
      • 3.3.3.1.30. Aggregate.pprogram_html
      • 3.3.3.1.31. Aggregate.price()
      • 3.3.3.1.32. Aggregate.q()
      • 3.3.3.1.33. Aggregate.q_sev()
      • 3.3.3.1.34. Aggregate.recommend_bucket()
      • 3.3.3.1.35. Aggregate.reinsurance_audit_df
      • 3.3.3.1.36. Aggregate.reinsurance_description()
      • 3.3.3.1.37. Aggregate.reinsurance_df
      • 3.3.3.1.38. Aggregate.reinsurance_kinds()
      • 3.3.3.1.39. Aggregate.reinsurance_occ_layer_df
      • 3.3.3.1.40. Aggregate.reinsurance_occ_plot()
      • 3.3.3.1.41. Aggregate.reinsurance_report_df
      • 3.3.3.1.42. Aggregate.report_df
      • 3.3.3.1.43. Aggregate.rescale()
      • 3.3.3.1.44. Aggregate.sample()
      • 3.3.3.1.45. Aggregate.sev
      • 3.3.3.1.46. Aggregate.severity_error_analysis()
      • 3.3.3.1.47. Aggregate.sf()
      • 3.3.3.1.48. Aggregate.snap()
      • 3.3.3.1.49. Aggregate.spec
      • 3.3.3.1.50. Aggregate.spec_ex
      • 3.3.3.1.51. Aggregate.statistics
      • 3.3.3.1.52. Aggregate.tvar()
      • 3.3.3.1.53. Aggregate.tvar_sev()
      • 3.3.3.1.54. Aggregate.update()
      • 3.3.3.1.55. Aggregate.update_work()
      • 3.3.3.1.56. Aggregate.valid
      • 3.3.3.1.57. Aggregate.var_dict()
• 3.4. Portfolio Module
  • 3.4.1. Portfolio Class
    • 3.4.1.1. Portfolio
      • 3.4.1.1.1. Portfolio.__init__()
      • 3.4.1.1.2. Portfolio._make_var_tvar()
      • 3.4.1.1.3. Portfolio._repr_html_()
      • 3.4.1.1.4. Portfolio.accounting_economic_balance_sheet()
      • 3.4.1.1.5. Portfolio.add_exa()
      • 3.4.1.1.6. Portfolio.add_exa_details()
      • 3.4.1.1.7. Portfolio.add_exa_sample()
      • 3.4.1.1.8. Portfolio.analysis_collateral()
      • 3.4.1.1.9. Portfolio.analysis_priority()
      • 3.4.1.1.10. Portfolio.analyze_distortion()
      • 3.4.1.1.11. Portfolio.analyze_distortion_add_comps()
      • 3.4.1.1.12. Portfolio.analyze_distortion_plots()
      • 3.4.1.1.13. Portfolio.analyze_distortions()
      • 3.4.1.1.14. Portfolio.apply_distortion()
      • 3.4.1.1.15. Portfolio.apply_distortions()
      • 3.4.1.1.16. Portfolio.approximate()
      • 3.4.1.1.17. Portfolio.as_severity()
      • 3.4.1.1.18. Portfolio.audits()
      • 3.4.1.1.19. Portfolio.best_bucket()
      • 3.4.1.1.20. Portfolio.biv_contour_plot()
      • 3.4.1.1.21. Portfolio.bodoff()
      • 3.4.1.1.22. Portfolio.calibrate_blends()
      • 3.4.1.1.23. Portfolio.calibrate_distortion()
      • 3.4.1.1.24. Portfolio.calibrate_distortions()
      • 3.4.1.1.25. Portfolio.cdf()
      • 3.4.1.1.26. Portfolio.collapse()
      • 3.4.1.1.27. Portfolio.cotvar()
      • 3.4.1.1.28. Portfolio.create_from_sample()
      • 3.4.1.1.29. Portfolio.density_sample()
      • 3.4.1.1.30. Portfolio.describe
      • 3.4.1.1.31. Portfolio.distortion_df
      • 3.4.1.1.32. Portfolio.epd_2_assets
      • 3.4.1.1.33. Portfolio.equal_risk_epd()
      • 3.4.1.1.34. Portfolio.equal_risk_var_tvar()
      • 3.4.1.1.35. Portfolio.explain_validation()
      • 3.4.1.1.36. Portfolio.from_DataFrame()
      • 3.4.1.1.37. Portfolio.from_Excel()
      • 3.4.1.1.38. Portfolio.from_dict_of_aggs()
      • 3.4.1.1.39. Portfolio.ft()
      • 3.4.1.1.40. Portfolio.gamma()
      • 3.4.1.1.41. Portfolio.gradient()
      • 3.4.1.1.42. Portfolio.ift()
      • 3.4.1.1.43. Portfolio.json()
      • 3.4.1.1.44. Portfolio.limits()
      • 3.4.1.1.45. Portfolio.line_renamer
      • 3.4.1.1.46. Portfolio.make_all()
      • 3.4.1.1.47. Portfolio.make_audit_df()
      • 3.4.1.1.48. Portfolio.merton_perold()
      • 3.4.1.1.49. Portfolio.more()
      • 3.4.1.1.50. Portfolio.multi_premium_capital()
      • 3.4.1.1.51. Portfolio.natural_profit_segment_plot()
      • 3.4.1.1.52. Portfolio.nice_program()
      • 3.4.1.1.53. Portfolio.pdf()
      • 3.4.1.1.54. Portfolio.percentiles()
      • 3.4.1.1.55. Portfolio.plot()
      • 3.4.1.1.56. Portfolio.pmf()
      • 3.4.1.1.57. Portfolio.pprogram
      • 3.4.1.1.58. Portfolio.pprogram_html
      • 3.4.1.1.59. Portfolio.premium_capital()
      • 3.4.1.1.60. Portfolio.price()
      • 3.4.1.1.61. Portfolio.price_ccoc()
      • 3.4.1.1.62. Portfolio.pricing_bounds()
      • 3.4.1.1.63. Portfolio.profit_segment_plot()
      • 3.4.1.1.64. Portfolio.q()
      • 3.4.1.1.65. Portfolio.recommend_bucket()
      • 3.4.1.1.66. Portfolio.remove_fuzz()
      • 3.4.1.1.67. Portfolio.renamer
      • 3.4.1.1.68. Portfolio.report()
      • 3.4.1.1.69. Portfolio.sample()
      • 3.4.1.1.70. Portfolio.sample_compare()
      • 3.4.1.1.71. Portfolio.sample_density_compare()
      • 3.4.1.1.72. Portfolio.save()
      • 3.4.1.1.73. Portfolio.scatter()
      • 3.4.1.1.74. Portfolio.set_a_p()
      • 3.4.1.1.75. Portfolio.sf()
      • 3.4.1.1.76. Portfolio.show_enhanced_exhibits()
      • 3.4.1.1.77. Portfolio.snap()
      • 3.4.1.1.78. Portfolio.spec
      • 3.4.1.1.79. Portfolio.spec_ex
      • 3.4.1.1.80. Portfolio.stand_alone_pricing()
      • 3.4.1.1.81. Portfolio.stand_alone_pricing_work()
      • 3.4.1.1.82. Portfolio.statistics
      • 3.4.1.1.83. Portfolio.tm_renamer
      • 3.4.1.1.84. Portfolio.trim_df()
      • 3.4.1.1.85. Portfolio.tvar()
      • 3.4.1.1.86. Portfolio.tvar_threshold()
      • 3.4.1.1.87. Portfolio.twelve_plot()
      • 3.4.1.1.88. Portfolio.uat()
      • 3.4.1.1.89. Portfolio.uat_differential()
      • 3.4.1.1.90. Portfolio.uat_interpolation_functions()
      • 3.4.1.1.91. Portfolio.update()
      • 3.4.1.1.92. Portfolio.valid
      • 3.4.1.1.93. Portfolio.var()
      • 3.4.1.1.94. Portfolio.var_dict()
  • 3.4.2. Other Portfolio functions
    • 3.4.2.1. check01()
    • 3.4.2.2. convex_points()
    • 3.4.2.3. make_array()
    • 3.4.2.4. make_awkward()
• 3.5. Utilities
  • 3.5.1. Moment Aggregator Class
    • 3.5.1.1. MomentAggregator
      • 3.5.1.1.1. MomentAggregator.__init__()
      • 3.5.1.1.2. MomentAggregator.add_f1s()
      • 3.5.1.1.3. MomentAggregator.add_fs()
      • 3.5.1.1.4. MomentAggregator.add_fs2()
      • 3.5.1.1.5. MomentAggregator.agg_from_fs()
      • 3.5.1.1.6. MomentAggregator.agg_from_fs2()
      • 3.5.1.1.7. MomentAggregator.column_names()
      • 3.5.1.1.8. MomentAggregator.cumulate_moments()
      • 3.5.1.1.9. MomentAggregator.get_fsa_stats()
      • 3.5.1.1.10. MomentAggregator.moments()
      • 3.5.1.1.11. MomentAggregator.moments_to_mcvsk()
      • 3.5.1.1.12. MomentAggregator.static_moments_to_mcvsk()
      • 3.5.1.1.13. MomentAggregator.stats_series()
  • 3.5.2. Moment Wrangler Class
    • 3.5.2.1. MomentWrangler
      • 3.5.2.1.1. MomentWrangler.__init__()
      • 3.5.2.1.2. MomentWrangler._make_factorial()
  • 3.5.3. Axis Manager Class
    • 3.5.3.1. AxisManager
      • 3.5.3.1.1. AxisManager.__init__()
      • 3.5.3.1.2. AxisManager.dimensions()
      • 3.5.3.1.3. AxisManager.good_grid()
      • 3.5.3.1.4. AxisManager.grid()
      • 3.5.3.1.5. AxisManager.grid_size()
      • 3.5.3.1.6. AxisManager.make_figure()
      • 3.5.3.1.7. AxisManager.print_fig()
      • 3.5.3.1.8. AxisManager.size_figure()
      • 3.5.3.1.9. AxisManager.tidy()
      • 3.5.3.1.10. AxisManager.tidy_up()
  • 3.5.4. Utilities Module
    • 3.5.4.1. Answer
      • 3.5.4.1.1. Answer.__init__()
      • 3.5.4.1.2. Answer._repr_html_()
      • 3.5.4.1.3. Answer.list()
      • 3.5.4.1.4. Answer.nice()
      • 3.5.4.1.5. Answer.summary()
    • 3.5.4.2. GCN
      • 3.5.4.2.1. GCN._asdict()
      • 3.5.4.2.2. GCN._make()
      • 3.5.4.2.3. GCN._replace()
      • 3.5.4.2.4. GCN.ceded
      • 3.5.4.2.5. GCN.gross
      • 3.5.4.2.6. GCN.net
    • 3.5.4.3. GreatFormatter
      • 3.5.4.3.1. GreatFormatter.__init__()
    • 3.5.4.4. approximate_work()
    • 3.5.4.5. axiter_factory()
    • 3.5.4.6. block_iman_conover()
    • 3.5.4.7. easy_formatter()
    • 3.5.4.8. estimate_agg_percentile()
    • 3.5.4.9. explain_validation()
    • 3.5.4.10. frequency_examples()
    • 3.5.4.11. friendly()
    • 3.5.4.12. ft()
    • 3.5.4.13. gamma_fit()
    • 3.5.4.14. get_fmts()
    • 3.5.4.15. html_title()
    • 3.5.4.16. ic_noise()
    • 3.5.4.17. ic_rank()
    • 3.5.4.18. ic_reorder()
    • 3.5.4.19. ic_t_noise()
    • 3.5.4.20. ift()
    • 3.5.4.21. iman_conover()
    • 3.5.4.22. integral_by_doubling()
    • 3.5.4.23. introspect()
    • 3.5.4.24. kaplan_meier()
    • 3.5.4.25. kaplan_meier_np()
    • 3.5.4.26. knobble_fonts()
    • 3.5.4.27. ln_fit()
    • 3.5.4.28. log_test()
    • 3.5.4.29. logarithmic_theta()
    • 3.5.4.30. logger_level()
    • 3.5.4.31. lognorm_approx()
    • 3.5.4.32. lognorm_lev()
    • 3.5.4.33. make_ceder_netter()
    • 3.5.4.34. make_corr_matrix()
    • 3.5.4.35. make_mosaic_figure()
    • 3.5.4.36. make_var_tvar()
    • 3.5.4.37. moms_analytic()
    • 3.5.4.38. more()
    • 3.5.4.39. mu_sigma_from_mean_cv()
    • 3.5.4.40. mv()
    • 3.5.4.41. nice_multiple()
    • 3.5.4.42. parse_note()
    • 3.5.4.43. parse_note_ex()
    • 3.5.4.44. partial_e()
    • 3.5.4.45. partial_e_numeric()
    • 3.5.4.46. picks_work()
    • 3.5.4.47. pprint()
    • 3.5.4.48. pprint_ex()
    • 3.5.4.49. qd()
    • 3.5.4.50. qdp()
    • 3.5.4.51. random_corr_matrix()
    • 3.5.4.52. rearrangement_algorithm_max_VaR()
    • 3.5.4.53. round_bucket()
    • 3.5.4.54. sEngFormatter
      • 3.5.4.54.1. sEngFormatter.__init__()
      • 3.5.4.54.2. sEngFormatter.remove_trailing_zeros()
    • 3.5.4.55. sensible_jump()
    • 3.5.4.56. sgamma_fit()
    • 3.5.4.57. show_fig()
    • 3.5.4.58. sln_fit()
    • 3.5.4.59. style_df()
    • 3.5.4.60. subsets()
    • 3.5.4.61. suptitle_and_tight()
    • 3.5.4.62. test_var_tvar()
    • 3.5.4.63. tweedie_convert()
    • 3.5.4.64. tweedie_density()
    • 3.5.4.65. xsden_to_meancv()
    • 3.5.4.66. xsden_to_meancvskew()
  • 3.5.5. Constants
    • 3.5.5.1. Validation
• 3.6. Distortion Module
  • 3.6.1. Distortion
    • 3.6.1.1. Distortion.__init__()
    • 3.6.1.2. Distortion.available_distortions()
    • 3.6.1.3. Distortion.average_distortion()
    • 3.6.1.4. Distortion.bagged_distortion()
    • 3.6.1.5. Distortion.convex_example()
    • 3.6.1.6. Distortion.distortions_from_params()
    • 3.6.1.7. Distortion.g_dual()
    • 3.6.1.8. Distortion.plot()
    • 3.6.1.9. Distortion.price()
    • 3.6.1.10. Distortion.price2()
    • 3.6.1.11. Distortion.s_gs_distortion()
    • 3.6.1.12. Distortion.test()
    • 3.6.1.13. Distortion.wtd_tvar()
  • 3.6.2. approx_ccoc()
  • 3.6.3. tvar_weights()
• 3.7. Bounds Module
  • 3.7.1. Bounds
    • 3.7.1.1. Bounds.__init__()
    • 3.7.1.2. Bounds.cloud_view()
    • 3.7.1.3. Bounds.compute_weight()
    • 3.7.1.4. Bounds.compute_weights()
    • 3.7.1.5. Bounds.distortion()
    • 3.7.1.6. Bounds.make_ps()
    • 3.7.1.7. Bounds.make_tvar_function()
    • 3.7.1.8. Bounds.p_star()
    • 3.7.1.9. Bounds.ped_distortion()
    • 3.7.1.10. Bounds.principal_extreme_distortion_analysis()
    • 3.7.1.11. Bounds.quick_price()
    • 3.7.1.12. Bounds.tvar_array()
    • 3.7.1.13. Bounds.tvar_cloud()
    • 3.7.1.14. Bounds.tvar_hinges()
    • 3.7.1.15. Bounds.tvar_with_bound()
  • 3.7.2. Bounds
    • 3.7.2.1. Bounds.cloud_view()
    • 3.7.2.2. Bounds.compute_weight()
    • 3.7.2.3. Bounds.compute_weights()
    • 3.7.2.4. Bounds.distortion()
    • 3.7.2.5. Bounds.make_ps()
    • 3.7.2.6. Bounds.make_tvar_function()
    • 3.7.2.7. Bounds.p_star()
    • 3.7.2.8. Bounds.ped_distortion()
    • 3.7.2.9. Bounds.principal_extreme_distortion_analysis()
    • 3.7.2.10. Bounds.quick_price()
    • 3.7.2.11. Bounds.tvar_array()
    • 3.7.2.12. Bounds.tvar_cloud()
    • 3.7.2.13. Bounds.tvar_hinges()
    • 3.7.2.14. Bounds.tvar_with_bound()
  • 3.7.3. plot_lee()
  • 3.7.4. plot_max_min()
  • 3.7.5. similar_risks_example()
  • 3.7.6. similar_risks_graphs_sa()
• 3.8. Extensions
  • 3.8.1. Basic
  • 3.8.2. Case Study Support
    • 3.8.2.1. ClassicalPremium
      • 3.8.2.1.1. ClassicalPremium.calibrate()
      • 3.8.2.1.2. ClassicalPremium.distribution()
      • 3.8.2.1.3. ClassicalPremium.illustrate()
      • 3.8.2.1.4. ClassicalPremium.price()
      • 3.8.2.1.5. ClassicalPremium.prices()
      • 3.8.2.1.6. ClassicalPremium.pricing_exhibit()
    • 3.8.2.2. add_defaults()
    • 3.8.2.3. bivariate_density_plots()
    • 3.8.2.4. extract_sort_order()
    • 3.8.2.5. g_ins_stats()
    • 3.8.2.6. macro_market_graphs()
    • 3.8.2.7. pricing()
    • 3.8.2.8. universal_renamer()
    • 3.8.2.9. urn()
  • 3.8.3. Pentagon
    • 3.8.3.1. code()
    • 3.8.3.2. make_possible_pentagons()
    • 3.8.3.3. pent_ans
      • 3.8.3.3.1. pent_ans.COC
      • 3.8.3.3.2. pent_ans.L
      • 3.8.3.3.3. pent_ans.LR
      • 3.8.3.3.4. pent_ans.M
      • 3.8.3.3.5. pent_ans.P
      • 3.8.3.3.6. pent_ans.PQ
      • 3.8.3.3.7. pent_ans.Q
      • 3.8.3.3.8. pent_ans.a
  • 3.8.4. Samples
  • 3.8.5. Figures
    • 3.8.5.1. adjusting_layer_losses()
    • 3.8.5.2. discretization_agg_example()
    • 3.8.5.3. discretization_sev_example()
    • 3.8.5.4. dual_distortion()
    • 3.8.5.5. g_insurance_statistics()
    • 3.8.5.6. g_risk_appetite()
    • 3.8.5.7. gh_example()
    • 3.8.5.8. mixing_convergence()
    • 3.8.5.9. power_variance_family()
    • 3.8.5.10. savings_charge()
  • 3.8.6. PIR Figures
    • 3.8.6.1. curlyBrace()
    • 3.8.6.2. fig_10_3()
    • 3.8.6.3. fig_10_5()
    • 3.8.6.4. fig_10_6()
    • 3.8.6.5. fig_4_1()
    • 3.8.6.6. getAxSize()
    • 3.8.6.7. natural_scale()
  • 3.8.7. Test Suite