docs-v2/content/flux/v0/stdlib/math/dim.md

title	description	menu	weight
math.dim() function	`math.dim()` returns the maximum of `x - y` or `0`.	flux_v0_ref name parent identifier math.dim math math/dim	101

math.dim() returns the maximum of x - y or 0.

Function type signature

(x: float, y: float) => float

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

x

({{< req >}}) x-value to use in the operation.

y

({{< req >}}) y-value to use in the operation.

Examples

• Return the maximum difference between two values
• Use math.dim in map

Return the maximum difference between two values

import "math"

math.dim(x: 12.2, y: 8.1)// 4.1

Use math.dim in map

import "math"

data
    |> map(fn: (r) => ({_time: r._time, _value: math.dim(x: r.x, y: r.y)}))

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time	x	y
2021-01-01T00:00:00Z	3.9	1.2
2021-01-01T01:00:00Z	4.2	2.4
2021-01-01T02:00:00Z	5.3	3.6
2021-01-01T03:00:00Z	6.8	4.8
2021-01-01T04:00:00Z	7.5	5.1

Output data

_time	_value
2021-01-01T00:00:00Z	2.7
2021-01-01T01:00:00Z	1.8000000000000003
2021-01-01T02:00:00Z	1.6999999999999997
2021-01-01T03:00:00Z	2
2021-01-01T04:00:00Z	2.4000000000000004

{{% /expand %}} {{< /expand-wrapper >}}