Hastructure-0.50.0: Cashflow modeling library for structured finance
Safe HaskellNone
LanguageHaskell2010

AssetClass.Lease

Synopsis

Documentation

data Lease Source #

Constructors

RegularLease OriginalInfo Balance RemainTerms Status 
StepUpLease OriginalInfo LeaseStepUp Balance RemainTerms Status 

Instances

Instances details
Asset Lease Source # 
Instance details

Defined in AssetClass.Lease

Methods

calcCashflow :: Lease -> Date -> Maybe [RateAssumption] -> Either String CashFlowFrame Source #

getCurrentBal :: Lease -> Balance Source #

getOriginBal :: Lease -> Balance Source #

getOriginRate :: Lease -> IRate Source #

getCurrentRate :: Lease -> IRate Source #

getOriginDate :: Lease -> Date Source #

getOriginInfo :: Lease -> OriginalInfo Source #

isDefaulted :: Lease -> Bool Source #

getPaymentDates :: Lease -> Int -> [Date] Source #

getRemainTerms :: Lease -> Int Source #

getRemainDates :: Lease -> [Date] Source #

getTotalTerms :: Lease -> Int Source #

getPastTerms :: Lease -> Int Source #

projCashflow :: Lease -> Date -> AssetPerf -> Maybe [RateAssumption] -> Either String (CashFlowFrame, Map CutoffFields Balance) Source #

getBorrowerNum :: Lease -> Int Source #

splitWith :: Lease -> [Rate] -> [Lease] Source #

updateOriginDate :: Lease -> Date -> Lease Source #

resetToOrig :: Lease -> Lease Source #

getLastInterestPaymentDate :: Lease -> Maybe Date Source #

calcAccruedInterest :: Lease -> Date -> Balance Source #

calcAlignDate :: Lease -> Date -> Date Source #

getObligor :: Lease -> Maybe Obligor Source #

getObligorTags :: Lease -> Set String Source #

getObligorId :: Lease -> Maybe String Source #

getObligorFields :: Lease -> Maybe (Map String (Either String Double)) Source #

UseRate Lease Source # 
Instance details

Defined in AssetClass.AssetBase

Methods

isAdjustbleRate :: Lease -> Bool Source #

getIndex :: Lease -> Maybe Index Source #

getIndexes :: Lease -> Maybe [Index] Source #

getResetDates :: Lease -> Dates Source #

getSpread :: Lease -> Maybe Spread Source #

FromJSON Lease Source # 
Instance details

Defined in AssetClass.AssetBase

Methods

parseJSON :: Value -> Parser Lease #

parseJSONList :: Value -> Parser [Lease] #

omittedField :: Maybe Lease #

ToJSON Lease Source # 
Instance details

Defined in AssetClass.AssetBase

Methods

toJSON :: Lease -> Value #

toEncoding :: Lease -> Encoding #

toJSONList :: [Lease] -> Value #

toEncodingList :: [Lease] -> Encoding #

omitField :: Lease -> Bool #

Generic Lease Source # 
Instance details

Defined in AssetClass.AssetBase

Associated Types

type Rep Lease 
Instance details

Defined in AssetClass.AssetBase

type Rep Lease = D1 ('MetaData "Lease" "AssetClass.AssetBase" "Hastructure-0.50.0-9tFAxbqhtE23KiGoJqUlJG" 'False) (C1 ('MetaCons "RegularLease" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OriginalInfo) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Balance)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemainTerms) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status))) :+: C1 ('MetaCons "StepUpLease" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OriginalInfo) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LeaseStepUp)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Balance) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemainTerms) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)))))

Methods

from :: Lease -> Rep Lease x #

to :: Rep Lease x -> Lease #

Show Lease Source # 
Instance details

Defined in AssetClass.AssetBase

Methods

showsPrec :: Int -> Lease -> ShowS #

show :: Lease -> String #

showList :: [Lease] -> ShowS #

Eq Lease Source # 
Instance details

Defined in AssetClass.AssetBase

Methods

(==) :: Lease -> Lease -> Bool #

(/=) :: Lease -> Lease -> Bool #

Ord Lease Source # 
Instance details

Defined in AssetClass.AssetBase

Methods

compare :: Lease -> Lease -> Ordering #

(<) :: Lease -> Lease -> Bool #

(<=) :: Lease -> Lease -> Bool #

(>) :: Lease -> Lease -> Bool #

(>=) :: Lease -> Lease -> Bool #

max :: Lease -> Lease -> Lease #

min :: Lease -> Lease -> Lease #

type Rep Lease Source # 
Instance details

Defined in AssetClass.AssetBase

type Rep Lease = D1 ('MetaData "Lease" "AssetClass.AssetBase" "Hastructure-0.50.0-9tFAxbqhtE23KiGoJqUlJG" 'False) (C1 ('MetaCons "RegularLease" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OriginalInfo) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Balance)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemainTerms) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status))) :+: C1 ('MetaCons "StepUpLease" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OriginalInfo) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LeaseStepUp)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Balance) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemainTerms) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)))))

projCashflow :: Asset a => a -> Date -> AssetPerf -> Maybe [RateAssumption] -> Either String (CashFlowFrame, Map CutoffFields Balance) Source #

updateOriginDate :: Asset a => a -> Date -> a Source #

! Change the origination date of an asset

Orphan instances