Documentation

Actus.Contract.UMP

def Actus.Contract.UMP.stf_IED {α : Type} [Amount α] (ct : Terms α) (t : Protocol.Time) (s : State α) :

Initial exchange: take on the (unsigned) notional and the nominal rate.

Equations
Instances For
    def Actus.Contract.UMP.stf_IPCI {α : Type} [Amount α] (rf : RiskFactorEnv α) (t : Protocol.Time) (s : State α) :

    Interest capitalization (no cash): compound the notional by the interest accrued over [Sd, t], then reset the accrual.

    Equations
    • One or more equations did not get rendered due to their size.
    Instances For
      def Actus.Contract.UMP.stf_TD {α : Type} [Amount α] (rf : RiskFactorEnv α) (t : Protocol.Time) (s : State α) :

      Termination: record the interest accrued on the capitalized notional since the last capitalization (settled by pof_TD).

      Equations
      • One or more equations did not get rendered due to their size.
      Instances For
        def Actus.Contract.UMP.stf {α : Type} [Amount α] (ct : Terms α) (rf : RiskFactorEnv α) (ev : Protocol.EventType) (t : Protocol.Time) (s : State α) :

        STF dispatcher (events outside the UMP schedule just advance the clock).

        Equations
        Instances For
          def Actus.Contract.UMP.pof_TD {α : Type} [Amount α] (ct : Terms α) (rf : RiskFactorEnv α) (t : Protocol.Time) (s : State α) :
          α

          Termination payoff: buy-back price plus interest accrued since the last capitalization, on the capitalized notional.

          Equations
          Instances For
            def Actus.Contract.UMP.init {α : Type} [Amount α] (ct : Terms α) (t₀ : Protocol.Time) :

            Pre-IED state at t₀; stf_IED overwrites the monetary fields.

            Equations
            • One or more equations did not get rendered due to their size.
            Instances For
              inductive Actus.Contract.UMP.Step {α : Type} [Amount α] (ct : Terms α) (rf : RiskFactorEnv α) :
              State αState αType

              One-step UMP transition. The constructor targets the dispatcher stf.

              Instances For
                @[reducible, inline]
                abbrev Actus.Contract.UMP.Trace {α : Type} [Amount α] (ct : Terms α) (rf : RiskFactorEnv α) :
                State αState αType
                Equations
                Instances For
                  def Actus.Contract.UMP.getCashflow {α : Type} [Amount α] (ct : Terms α) (rf : RiskFactorEnv α) {s s' : State α} (h : Step ct rf s s') :
                  Equations
                  Instances For
                    Equations
                    • One or more equations did not get rendered due to their size.
                    Instances For

                      UMP cash flows: thread UMP.stf/UMP.pof over the schedule IED, the capitalization (IPCI) cycle strictly before termination, then TD. IPCI is a non-cash capitalization, so its zero payoff is not reported.

                      Equations
                      • One or more equations did not get rendered due to their size.
                      Instances For