FloatPeriod
===========

.. currentmodule:: rateslib.periods

.. autoclass:: FloatPeriod
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~FloatPeriod.index_params
      ~FloatPeriod.is_indexed
      ~FloatPeriod.is_non_deliverable
      ~FloatPeriod.non_deliverable_params
      ~FloatPeriod.period_params
      ~FloatPeriod.rate_params
      ~FloatPeriod.settlement_params

   .. rubric:: Methods Summary

   .. autosummary::

      ~FloatPeriod.analytic_delta
      ~FloatPeriod.cashflow
      ~FloatPeriod.cashflows
      ~FloatPeriod.convert_deliverable
      ~FloatPeriod.immediate_local_npv
      ~FloatPeriod.index_up
      ~FloatPeriod.local_analytic_rate_fixings
      ~FloatPeriod.local_fixings
      ~FloatPeriod.local_npv
      ~FloatPeriod.npv
      ~FloatPeriod.rate
      ~FloatPeriod.reference_cashflow
      ~FloatPeriod.reset_fixings
      ~FloatPeriod.try_cashflow
      ~FloatPeriod.try_cashflow_analytic_delta
      ~FloatPeriod.try_cashflow_analytic_rate_fixings
      ~FloatPeriod.try_convert_deliverable
      ~FloatPeriod.try_immediate_analytic_rate_fixings
      ~FloatPeriod.try_immediate_local_analytic_delta
      ~FloatPeriod.try_immediate_local_npv
      ~FloatPeriod.try_index_up
      ~FloatPeriod.try_local_analytic_delta
      ~FloatPeriod.try_local_npv
      ~FloatPeriod.try_rate
      ~FloatPeriod.try_reference_cashflow
      ~FloatPeriod.try_reference_cashflow_analytic_delta
      ~FloatPeriod.try_reference_cashflow_analytic_rate_fixings
      ~FloatPeriod.try_unindexed_cashflow
      ~FloatPeriod.try_unindexed_cashflow_analytic_delta
      ~FloatPeriod.try_unindexed_cashflow_analytic_rate_fixings
      ~FloatPeriod.try_unindexed_reference_cashflow
      ~FloatPeriod.try_unindexed_reference_cashflow_analytic_delta
      ~FloatPeriod.try_unindexed_reference_cashflow_analytic_rate_fixings
      ~FloatPeriod.unindexed_cashflow
      ~FloatPeriod.unindexed_reference_cashflow

   .. rubric:: Attributes Documentation

   .. autoattribute:: index_params
   .. autoattribute:: is_indexed
   .. autoattribute:: is_non_deliverable
   .. autoattribute:: non_deliverable_params
   .. autoattribute:: period_params
   .. autoattribute:: rate_params
   .. autoattribute:: settlement_params

   .. rubric:: Methods Documentation

   .. automethod:: analytic_delta
   .. automethod:: cashflow
   .. automethod:: cashflows
   .. automethod:: convert_deliverable
   .. automethod:: immediate_local_npv
   .. automethod:: index_up
   .. automethod:: local_analytic_rate_fixings
   .. automethod:: local_fixings
   .. automethod:: local_npv
   .. automethod:: npv
   .. automethod:: rate
   .. automethod:: reference_cashflow
   .. automethod:: reset_fixings
   .. automethod:: try_cashflow
   .. automethod:: try_cashflow_analytic_delta
   .. automethod:: try_cashflow_analytic_rate_fixings
   .. automethod:: try_convert_deliverable
   .. automethod:: try_immediate_analytic_rate_fixings
   .. automethod:: try_immediate_local_analytic_delta
   .. automethod:: try_immediate_local_npv
   .. automethod:: try_index_up
   .. automethod:: try_local_analytic_delta
   .. automethod:: try_local_npv
   .. automethod:: try_rate
   .. automethod:: try_reference_cashflow
   .. automethod:: try_reference_cashflow_analytic_delta
   .. automethod:: try_reference_cashflow_analytic_rate_fixings
   .. automethod:: try_unindexed_cashflow
   .. automethod:: try_unindexed_cashflow_analytic_delta
   .. automethod:: try_unindexed_cashflow_analytic_rate_fixings
   .. automethod:: try_unindexed_reference_cashflow
   .. automethod:: try_unindexed_reference_cashflow_analytic_delta
   .. automethod:: try_unindexed_reference_cashflow_analytic_rate_fixings
   .. automethod:: unindexed_cashflow
   .. automethod:: unindexed_reference_cashflow