Function HistogramGetBounds(histogram\_id, left\_bound, right\_bound)

HistogramGetBounds

Through the function HistogramGetBounds you can obtain the lower and upper bounds of frequency interval in a histogram.

HistogramGetBounds(
     histogram_id,         ! (input) a scalar number
     left_bound,           ! (output) a one-dimensional parameter
     right_bound           ! (output) a one-dimensional parameter
     )

Arguments

histogram_id

A scalar value representing a histogram that was previously created using the HistogramCreate function.

left_bound

A one-dimensional identifier that will be filled with the left bound of each interval in the histogram. The cardinality of the domain set should be at least the number of intervals.

right_bound

A one-dimensional identifier that will be filled with the right bound of each interval in the histogram. The cardinality of the domain set should be at least the number of intervals.

Return Value

The function returns 1 if the bounds are retrieved successfully, or 0 otherwise.

See also

The functions HistogramCreate, HistogramSetDomain. Histogram support in AIMMS is discussed in full detail in Creating Histograms of the Language Reference.