SwiftAnnuity 1.0.1

You want to add pod 'SwiftAnnuity', '~> 1.0' similar to the following to your Podfile:

target 'MyApp' do
  pod 'SwiftAnnuity', '~> 1.0'
end

Then run a pod install inside your terminal, or from CocoaPods.app.

Alternatively to give it a test run, run the command:

pod try SwiftAnnuity

SwiftAnnuity 1.0.1

By
Stuart Wakefield

Library for calculating annuity payments

By Stuart Wakefield

Introduction
Requirements
Installation
Usage
API

Introduction

A Swift library used to calculate annuities.

Requirements

iOS 9.3
Xcode 8.0
Swift 3.0

Installation

To install to use within your project use Cocoapods and add the following to your Podfile:

pod 'SwiftAnnuity', '1.0.0-alpha'

Usage

var annuity = SwiftAnnuity(
  principal: NSDecimalNumber(string: "250000"),
  rate: NSDecimalNumber(string: "0.035"),
  term: 15,
  frequency: 12
)
annuity.total
annuity.payment

It is possible to find the principal and the total amount from the payment amount by using the payment initializer:

var annuity = SwiftAnnuity(
  payment: NSDecimalNumber(string: "1200"),
  rate: NSDecimalNumber(string: "0.035"),
  term: 15,
  frequency: 12
)
annuity.principal
annuity.total

It is also possible to find the principal and the payment amount from the total amount paid for the annuity by using the total initializer:

var annuity = SwiftAnnuity(
  total: NSDecimalNumber(string: "400000"),
  rate: NSDecimalNumber(string: "0.035"),
  term: 15,
  frequency: 12
)
annuity.principal
annuity.payment

API

`SwiftAnnuity(principal: NSDecimalNumber, rate: NSDecimalNumber, term: Int, frequency: Int = 1)`

Creates a new SwiftAnnuity object from the principal. Typically used to discover the total and payment for the given interest rate over the term.

`SwiftAnnuity(total: NSDecimalNumber, rate: NSDecimalNumber, term: Int, frequency: Int = 1)`

Creates a new SwiftAnnuity object from the total including interest over the term. Can be used to discover the principal by reversing the calculation.

`SwiftAnnuity(payment: NSDecimalNumber, rate: NSDecimalNumber, term: Int, frequency: Int = 1)`

Creates a new SwiftAnnuity object from the fixed payment. Can be used to discover the principal by reversing the calculation.

`annuity.rate: NSDecimalNumber`

Returns the rate for the SwiftAnnuity instance.

`annuity.term: Int`

Returns the term for the SwiftAnnuity instance.

`annuity.frequency`

Returns the frequency for the SwiftAnnuity instance.

`annuity.principal`

Returns the principal for the SwiftAnnuity instance.

`annuity.total`

Returns the total including interest for the SwiftAnnuity instance.

`annuity.payment`

Returns the payment amount for the SwiftAnnuity instance.