Skip to content
Ubiquev1.0.4
functionupsidepot
upsidepot(
x: array,
mar?: number,
dim?: 0 | 1
): number

Upside Potential.

Unconditional upper partial moment: mean(max(x - MAR, 0)). All observations, including zero contributions, count in the denominator.

Examples

Upside potential for a single asset

import { assertEquals, assertAlmostEquals } from "jsr:@std/assert";

const x = [0.003, 0.026, 0.015, -0.009, 0.014, 0.024, 0.015, 0.066, -0.014, 0.039];
assertAlmostEquals(upsidepot(x), 0.0202, 1.01e-14);

Upside potential with custom MAR

import { assertEquals, assertAlmostEquals } from "jsr:@std/assert";

assertAlmostEquals(upsidepot([0.05, 0.03, 0.08, -0.02], 0.04), 0.0125, 1e-14);

Upside potential for matrix (row-wise)

import { assertEquals, assertAlmostEquals } from "jsr:@std/assert";

const x = [0.003, 0.026, 0.015, -0.009, 0.014, 0.024, 0.015, 0.066, -0.014, 0.039];

const y = [-0.005, 0.081, 0.04, -0.037, -0.061, 0.058, -0.049, -0.021, 0.062, 0.058];
const matrix = [x, y];
const expected = [0.0202, 0.0299];
(upsidepot(matrix, 0, 0) as number[]).forEach((v, i) => assertAlmostEquals(v, expected[i], 1e-14));

Parameters

array of values

optional
mar: number

minimum acceptable return (def: 0)

optional
dim: 0 | 1

dimension 0: row, 1: column (def: 0)

Return Type

number

Upside Potential

upsidepot(
x: matrix,
mar?: number,
dim?: 0 | 1
): array | matrix

Upside Potential.

Unconditional upper partial moment: mean(max(x - MAR, 0)). All observations, including zero contributions, count in the denominator.

Examples

Upside potential for a single asset

import { assertEquals, assertAlmostEquals } from "jsr:@std/assert";

const x = [0.003, 0.026, 0.015, -0.009, 0.014, 0.024, 0.015, 0.066, -0.014, 0.039];
assertAlmostEquals(upsidepot(x), 0.0202, 1.01e-14);

Upside potential with custom MAR

import { assertEquals, assertAlmostEquals } from "jsr:@std/assert";

assertAlmostEquals(upsidepot([0.05, 0.03, 0.08, -0.02], 0.04), 0.0125, 1e-14);

Upside potential for matrix (row-wise)

import { assertEquals, assertAlmostEquals } from "jsr:@std/assert";

const x = [0.003, 0.026, 0.015, -0.009, 0.014, 0.024, 0.015, 0.066, -0.014, 0.039];

const y = [-0.005, 0.081, 0.04, -0.037, -0.061, 0.058, -0.049, -0.021, 0.062, 0.058];
const matrix = [x, y];
const expected = [0.0202, 0.0299];
(upsidepot(matrix, 0, 0) as number[]).forEach((v, i) => assertAlmostEquals(v, expected[i], 1e-14));

Parameters

array of values

optional
mar: number

minimum acceptable return (def: 0)

optional
dim: 0 | 1

dimension 0: row, 1: column (def: 0)

Return Type

Upside Potential