xirr

Documentation

Index

• Constants
• func IsPaymentsSumPositive(payments []IPayment) bool
• type CalcMethod
• type IOrderedPayments
  • func OrderPayments(payments []IPayment) IOrderedPayments
• type OrderedPayments
  • func (o *OrderedPayments) Count() int
  • func (o *OrderedPayments) GetAll() []IPayment
• type XIRRDeAnnualizeMethod
  • func NewXIRRDeAnnualizeMethod(minRateOfIrr float64, daysInYear uint16, methodParams *Params) XIRRDeAnnualizeMethod
  • func (method XIRRDeAnnualizeMethod) Calculate(payments IOrderedPayments) IResult
• type XIRRMethod
  • func NewXIRRMethod(minRateOfIrr float64, daysInYear uint16, methodParams *Params) XIRRMethod
  • func (method XIRRMethod) Calculate(payments IOrderedPayments) IResult

Constants

const IdealNPV = 0

const IrrEpsilon = 0.1

Functions

func IsPaymentsSumPositive

func IsPaymentsSumPositive(payments []IPayment) bool

Types

type CalcMethod

type CalcMethod interface {
	Calculate(payments IOrderedPayments) IResult
}

type IOrderedPayments

type IOrderedPayments interface {
	GetAll() []IPayment

	Count() int
}

func OrderPayments

func OrderPayments(payments []IPayment) IOrderedPayments

type OrderedPayments

type OrderedPayments struct {
	// contains filtered or unexported fields
}

Default implementation

func (*OrderedPayments) Count

func (o *OrderedPayments) Count() int

func (*OrderedPayments) GetAll

func (o *OrderedPayments) GetAll() []IPayment

type XIRRDeAnnualizeMethod

type XIRRDeAnnualizeMethod struct {
	XIRRMethod
}

XIRR numeric method with deannualisation support

func NewXIRRDeAnnualizeMethod

func NewXIRRDeAnnualizeMethod(minRateOfIrr float64, daysInYear uint16, methodParams *Params) XIRRDeAnnualizeMethod

func (XIRRDeAnnualizeMethod) Calculate

func (method XIRRDeAnnualizeMethod) Calculate(payments IOrderedPayments) IResult

XIRRCalcMethod implementation

type XIRRMethod

type XIRRMethod struct {
	// contains filtered or unexported fields
}

XIRR numeric method

func NewXIRRMethod

func NewXIRRMethod(minRateOfIrr float64, daysInYear uint16, methodParams *Params) XIRRMethod

func (XIRRMethod) Calculate

func (method XIRRMethod) Calculate(payments IOrderedPayments) IResult

XIRRCalcMethod implementation