McGinley Dynamic
Install and import#
npm install fintech-algorithmsimport { mcginleyDynamic } from "fintech-algorithms/technical-indicators/trend-smoothing/mcginley-dynamic";Signature#
mcginleyDynamic(input)Tracks close with McGinley's self-adjusting recursion, dividing the step toward the new close by k * period * (close / previous) ** 4 so the line accelerates when price runs away from it and coasts when price is near.
Parameters#
| Name | Type | Notes |
|---|---|---|
input | TopicInput | bars is a non-empty array of OHLCV records with strictly increasing timestamp, finite open, high, low, close and non-negative volume, all sharing one adjustment basis. From parameters this topic reads period, an integer of at least 2, default 14, and k, a finite number of at least 0.000001 that damps the step size, default 0.6. |
Returns#
TopicResult
series and latest carry a single key, value. There is no warm-up: the first bar is seeded with its own close, so ready_at is 0 and no entry is ever null.
Warm-up#
The first 0 bars positions are not applicable. Unlike the windowed smoothers in this family, the recursion is seeded directly from the first close, so value is populated from index 0 and ready_at is 0. period still controls how fast the line converges, it just does not delay the first print.
Errors#
- When
parameters.kis not a finite number of at least 0.000001 — throws Error - When
parameters.periodis not an integer of at least 2 — throws Error - When
barsis empty or a bar violates the OHLCV contract — throws Error
Complexity: time O(n),
space O(n).
Worked example#
executed Captured by running this function on the input its own test provides. Real output of real code — but not asserted against a published figure.
Input#
{
"bars": [
{
"timestamp": "2024-01-02",
"basis": "synthetic-unadjusted",
"open": 100,
"high": 101.45,
"low": 98.695,
"close": 100,
"volume": 750000,
"benchmark": 200
},
{
"timestamp": "2024-01-03",
"basis": "synthetic-unadjusted",
"open": 101.49111452,
"high": 103.38381693,
"low": 100.05480022,
"close": 101.78791214,
"volume": 795117,
"benchmark": 200.56326135
},
{
"timestamp": "2024-01-04",
"basis": "synthetic-unadjusted",
"open": 102.45519048,
"high": 104.6701838,
"low": 100.91147007,
"close": 102.9549389,
"volume": 840234,
"benchmark": 201.11020913
}
],
"parameters": {}
}Call#
mcginleyDynamic(input)Returns#
object with 9 fields: topic_id, title, state, ready, ready_at, series, latest, parameters, …
{
"topic_id": "D07-F01-A18",
"title": "McGinley Dynamic",
"state": "calculated",
"ready": true,
"ready_at": 0,
"series": {
"value": [
100,
100.19828143903013,
100.49269368385441,
100.78556845098775,
101.010298670479,
101.15287258809037
]
},
"latest": {
"value": 103.52627869720108
},
"parameters": {},
"diagnostics": {
"causal": true,
"input_count": 96
}
}Diagrams#
Calculation flow#
McGinley Dynamic calculation flow
flowchart LR
A["an oldest-to-newest finite price series, declared price so"] --> B["Validate order, basis, and finite values"]
B --> C["Apply the selected McGinley Dynamic convention"]
C --> D["Emit value, readiness, and diagnostics"]
D --> E["Interpret descriptively; test outcomes separately"]
B -->|invalid or insufficient| X["Withhold output with a reason"]
McGinley Dynamic readiness and evidence states
stateDiagram-v2
[*] --> Waiting
Waiting --> Ready: enough valid causal observations
Waiting --> Rejected: malformed or unsupported input
Ready --> Calculated: selected formula applied
Calculated --> Interpreted: diagnostic and limitation retained
Interpreted --> Ready: next observation arrives
Rejected --> Waiting: corrected input and deterministic reset
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.
References#
- TA-Lib function groups — see linked primary or authoritative record
- TA-Lib C/C++ API — see linked primary or authoritative record
- TA-Lib maintained source — see linked primary or authoritative record
- Evidence decision
- Level 1 evidence map