Log Return

Install and import#

bash

npm install fintech-algorithms

import { logReturn } from "fintech-algorithms/financial-mathematics-statistics-and-data-foundations/financial-arithmetic-time-value-and-returns/log-return";

Signature#

logReturn(input)

Worked example#

verified This is the worked example published in the article, replayed by the test suite on every run. The output cannot drift.

Input#

input

{
  "principal": 1000,
  "rate": 0.05,
  "periods": 3,
  "compoundsPerPeriod": 12,
  "futureValue": 1200,
  "cashFlows": [-1000, 400, 400, 400],
  "startValue": 100,
  "endValue": 110,
  "returns": [0.1, -0.05, 0.08],
  "frequency": 12,
  "periodicReturn": 0.01
}

Call#

logReturn(input)

Returns#

object with 2 fields: logReturn, recoveredSimpleReturn

{
  "logReturn": 0.09531017980432493,
  "recoveredSimpleReturn": 0.10000000000000009
}

Diagrams#

Calculation flow#

Log Return — four-part map

flowchart LR
    A["Name the input"] --> B["Apply: log return = ln(ending value / starting value)"]
    B --> C["Check units and boundary"]
    C --> D["Explain the output"]

How it works#

This page states the contract — how to call it correctly. The article explains the concept: why it works, and where it breaks.

Read the article →

References#

NIST_LOG - NIST Dataplot: Exponential and Logarithmic Functions — Institutional source
CFA_QM - CFA Institute Quantitative Methods Study Session — CFA Institute
Author-derived and synthetic boundary