isPeak

isPeak(X, [strict=true])

X is a numeric vector/matrix/table.

strict is a Boolean value. For a segment of continuous identical numbers forming a local maximum (referred to as a plateau), the value of strict determines whether the entire plateau is considered a peak.

• When strict = true, the plateau is not considered a peak, meaning all elements in the plateau return false.

• When strict = false,

  • If the number of elements in plateau is odd, the element at the middle will return true, while the others return false.

  • If even, the element on the left side of the two middle elements will return true, while the others return false.

If X is a vector, check if each element in X is the peak.

If X is a matrix, perform the aforementioned calculations on each column and return a matrix of the same size as X.

If X is a table, only the numeric columns are involved in the calculations.

v = [1, 2.2, 2.2, 2.2, 2.3, 1, 1.2]
isPeak(v)
// output: [false,false,false,false,true,false,false]

v = [1, 2.2, 2.2, 2.2, 1.6, 1, 1.2]
isPeak(v)
// output: [false,false,false,false,false,false,false]

isPeak(v, false)
// output: [false,false,true,false,false,false,false]

// Perform the calculations on each column in a matrix
m = matrix(3.3 2.8 5.6 NULL 2.5 1.2, 4.5 3.5 4.6 2.8 3.9 NULL)
isPeak(m)

// Perform the calculations on the numeric columns in a table
t = table(`01`01`00`01`02`00 as id, 2022.01.01 + 1..6 as date, 388.3 390.6 390.8 390.6 390.3 391.5 as price)
isPeak(t)

Related function: isValley