Nyholm\EffectiveInterest\Calculator

Complexity

Total Complexity

2

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	withSpecifiedPayments()	0	4	1
A	withEqualPayments()	0	4	1

<?php

namespace Nyholm\EffectiveInterest;

/**
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
class Calculator
{
    /**
     * Get the interest when you know all the payments and their dates. Use this function when you have
     * administration fees at the first payment and/or when payments are irregular.
     *
     * @param int    $principal
     * @param string $startDate in format 'YYYY-mm-dd'
     * @param array  $payments  array with payment dates and values ['YYYY-mm-dd'=>int]
     * @param float  $guess     A guess what the interest may be. Between zero and one. Example 0.045
     *
     * @return float
     */
    public function withSpecifiedPayments(int $principal, string $startDate, array $payments, float $guess): float

The parameter $principal is not used and could be removed.

The parameter $startDate is not used and could be removed.

The parameter $payments is not used and could be removed.

The parameter $guess is not used and could be removed.

    {
        return 0.045;
    }

    public function withEqualPayments()
    {
        // TODO implement NewtonRaphson call.
    }
}