Module io.github.ralfkonrad.quantlib

Package org.quantlib

Class YoYInflationIndex

java.lang.Object

org.quantlib.Observable

org.quantlib.Index

org.quantlib.InflationIndex

org.quantlib.YoYInflationIndex

All Implemented Interfaces:

AutoCloseable, org.quantlib.helpers.QuantLibJNIHelpers.AutoCloseable

Direct Known Subclasses:

YYEUHICP, YYEUHICPr, YYEUHICPXT, YYFRHICP, YYFRHICPr, YYUKRPI, YYUKRPIr, YYUSCPI, YYUSCPIr, YYZACPI, YYZACPIr

public class YoYInflationIndex
extends InflationIndex
implements org.quantlib.helpers.QuantLibJNIHelpers.AutoCloseable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YoYInflationIndex(long cPtr, boolean cMemoryOwn)
	YoYInflationIndex(String familyName, Region region, boolean revised, boolean interpolated, boolean ratio, Frequency frequency, Period availabilityLag, Currency currency)
	YoYInflationIndex(String familyName, Region region, boolean revised, boolean interpolated, boolean ratio, Frequency frequency, Period availabilityLag, Currency currency, YoYInflationTermStructureHandle ts)
	YoYInflationIndex(String familyName, Region region, boolean revised, boolean interpolated, Frequency frequency, Period availabilityLag, Currency currency)
	YoYInflationIndex(String familyName, Region region, boolean revised, boolean interpolated, Frequency frequency, Period availabilityLag, Currency currency, YoYInflationTermStructureHandle ts)
	YoYInflationIndex(ZeroInflationIndex underlyingIndex, boolean interpolated)
	YoYInflationIndex(ZeroInflationIndex underlyingIndex, boolean interpolated, YoYInflationTermStructureHandle ts)

Method Summary

Modifier and Type	Method	Description
YoYInflationIndex	clone(YoYInflationTermStructureHandle h)
void	delete()
protected void	finalize()
protected static long	getCPtr(YoYInflationIndex obj)
boolean	ratio()
protected void	swigSetCMemOwn(boolean own)
ZeroInflationIndex	underlyingIndex()
YoYInflationTermStructureHandle	yoyInflationTermStructure()

Methods inherited from class org.quantlib.InflationIndex

availabilityLag, currency, familyName, frequency, getCPtr, interpolated, region, revised

Methods inherited from class org.quantlib.Index

addFixing, addFixing, addFixings, addFixings, clearFixings, fixing, fixing, fixingCalendar, getCPtr, hasHistoricalFixing, isValidFixingDate, name, timeSeries, toString

Methods inherited from class org.quantlib.Observable

getCPtr

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.quantlib.helpers.QuantLibJNIHelpers.AutoCloseable

close

Constructor Detail

YoYInflationIndex

protected YoYInflationIndex(long cPtr,
                            boolean cMemoryOwn)

YoYInflationIndex

public YoYInflationIndex(ZeroInflationIndex underlyingIndex,
                         boolean interpolated,
                         YoYInflationTermStructureHandle ts)

YoYInflationIndex

public YoYInflationIndex(ZeroInflationIndex underlyingIndex,
                         boolean interpolated)

YoYInflationIndex

public YoYInflationIndex(String familyName,
                         Region region,
                         boolean revised,
                         boolean interpolated,
                         Frequency frequency,
                         Period availabilityLag,
                         Currency currency,
                         YoYInflationTermStructureHandle ts)

YoYInflationIndex

public YoYInflationIndex(String familyName,
                         Region region,
                         boolean revised,
                         boolean interpolated,
                         Frequency frequency,
                         Period availabilityLag,
                         Currency currency)

YoYInflationIndex

public YoYInflationIndex(String familyName,
                         Region region,
                         boolean revised,
                         boolean interpolated,
                         boolean ratio,
                         Frequency frequency,
                         Period availabilityLag,
                         Currency currency,
                         YoYInflationTermStructureHandle ts)

YoYInflationIndex

public YoYInflationIndex(String familyName,
                         Region region,
                         boolean revised,
                         boolean interpolated,
                         boolean ratio,
                         Frequency frequency,
                         Period availabilityLag,
                         Currency currency)

Method Detail

getCPtr

protected static long getCPtr(YoYInflationIndex obj)

swigSetCMemOwn

protected void swigSetCMemOwn(boolean own)

Overrides:

swigSetCMemOwn in class InflationIndex

finalize

protected void finalize()

Overrides:

finalize in class InflationIndex

delete

public void delete()

Specified by:

delete in interface org.quantlib.helpers.QuantLibJNIHelpers.AutoCloseable

Overrides:

delete in class InflationIndex

ratio

public boolean ratio()

underlyingIndex

public ZeroInflationIndex underlyingIndex()

yoyInflationTermStructure

public YoYInflationTermStructureHandle yoyInflationTermStructure()

clone

public YoYInflationIndex clone(YoYInflationTermStructureHandle h)