High-Low Range Percentage
Install and import#
npm install fintech-algorithmsimport { highLowRangePercentage } from "fintech-algorithms/technical-indicators/range-and-volatility-indicators/high-low-range-percentage";Signature#
highLowRangePercentage(input)Expresses the bar's high-low range as a percentage of its high-low midpoint: 200 * (high - low) / (high + low).
Parameters#
| Name | Type | Notes |
|---|---|---|
input | TopicInput | bars is the required OHLCV array -- each bar carries timestamp, open, high, low, close, volume and an optional basis, strictly ordered by timestamp. This topic reads no keys of its own from parameters, but the family still validates period (default 14, integer >= 2) before the branch runs, so an invalid period is rejected here too. |
Returns#
TopicResult
series holds a single key, value, the per-bar range percentage; latest.value is the last bar's reading. There is no warm-up -- the calculation is per-bar, so ready_at is 0.
Warm-up#
The first 0 bars positions are not applicable. Every bar is self-contained, so value is populated from index 0. The only null case is a bar where high + low is exactly zero.
Errors#
- When
parameters.periodis not an integer >= 2 — throws Error - When a bar is missing open, high, low, close, or volume, or one of them is not a finite number — throws Error
- When bars are not strictly ordered by timestamp, or a bar's high is below its open, low, or close — 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#
highLowRangePercentage(input)Returns#
object with 9 fields: topic_id, title, state, ready, ready_at, series, latest, parameters, …
{
"topic_id": "D07-F06-A10",
"title": "High-Low Range Percentage",
"state": "calculated",
"ready": true,
"ready_at": 0,
"series": {
"value": [
2.753004072047775,
3.272748071764005,
3.6566626050949482,
3.82208970566863,
3.7288541366298587,
3.392411654116297
]
},
"latest": {
"value": 3.1131062534873144
},
"parameters": {},
"diagnostics": {
"causal": true,
"input_count": 96
}
}Diagrams#
Calculation flow#
High-Low Range Percentage calculation flow
flowchart LR
A["ordered OHLC observations with session calendar, previous "] --> B["Validate order, basis, and finite values"]
B --> C["Apply the selected High-Low Range Percentage 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"]
High-Low Range Percentage 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