tuple_histo_rangeT_tuple_histo_rangeTupleHistoRangeTupleHistoRange (Operator)


tuple_histo_rangeT_tuple_histo_rangeTupleHistoRangeTupleHistoRange — Calculate the value distribution of a tuple within a certain value range.


tuple_histo_range( : : Tuple, Min, Max, NumBins : Histo, BinSize)

Herror T_tuple_histo_range(const Htuple Tuple, const Htuple Min, const Htuple Max, const Htuple NumBins, Htuple* Histo, Htuple* BinSize)

void TupleHistoRange(const HTuple& Tuple, const HTuple& Min, const HTuple& Max, const HTuple& NumBins, HTuple* Histo, HTuple* BinSize)

HTuple HTuple::TupleHistoRange(const HTuple& Min, const HTuple& Max, const HTuple& NumBins, HTuple* BinSize) const

static void HOperatorSet.TupleHistoRange(HTuple tuple, HTuple min, HTuple max, HTuple numBins, out HTuple histo, out HTuple binSize)

HTuple HTuple.TupleHistoRange(HTuple min, HTuple max, HTuple numBins, out HTuple binSize)


tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangeTupleHistoRange calculates the value distribution HistoHistoHistoHistohisto of the TupleTupleTupleTupletuple within the value range [MinMinMinMinmin,MaxMaxMaxMaxmax]. The values for MinMinMinMinmin and MaxMaxMaxMaxmax are rounded down to the next integer if all entries of the TupleTupleTupleTupletuple are of type integer. The value range is divided into NumBinsNumBinsNumBinsNumBinsnumBins bins of the same size, which is returned in BinSizeBinSizeBinSizeBinSizebinSize. If a value lies between two bins the value is assigned to the smaller bin. If the TupleTupleTupleTupletuple has entries of type real . If all entries are of type integer the size of a bin is computed with .

Exception: Empty input tuples

If any of the input tuples is empty, an exception is raised.


If all the data of the TupleTupleTupleTupletuple are of type integer the value of BinSizeBinSizeBinSizeBinSizebinSize may cause the following effects: For BinSizeBinSizeBinSizeBinSizebinSize > 1 multiple consecutive numbers are assigned to the same bin. If BinSizeBinSizeBinSizeBinSizebinSize is no integer the numbers are distributed uneven among the bins, e.g., for BinSizeBinSizeBinSizeBinSizebinSize = 1.5 the first and second number are assigned to the first bin, the third number is assigned to the second bin, and the fourth and fifth number are assigned to the third bin. This becomes noticeable in several peeks in the histogram HistoHistoHistoHistohisto. If BinSizeBinSizeBinSizeBinSizebinSize < 1 some classes are not assigned by any number, e.g., for BinSizeBinSizeBinSizeBinSizebinSize = 0.5 the first number is assigned to the first bin and the second number is assigned to the third bin. The histogram HistoHistoHistoHistohisto shows some gaps, which resembles the structure of a comb.

If the TupleTupleTupleTupletuple has entries of type real and MinMinMinMinmin = MaxMaxMaxMaxmax, all entries of the corresponding value are assigned only to the first bin.

Execution Information


TupleTupleTupleTupletuple (input_control)  number-array HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Input tuple.

MinMinMinMinmin (input_control)  number HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Minimum value.

MaxMaxMaxMaxmax (input_control)  number HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Maximum value.

Restriction: Max >= Min

NumBinsNumBinsNumBinsNumBinsnumBins (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of bins.

Restriction: NumBins >= 1

HistoHistoHistoHistohisto (output_control)  histogram(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Histogram to be calculated.

BinSizeBinSizeBinSizeBinSizebinSize (output_control)  real HTupleHTupleHtuple (real) (double) (double) (double)

Bin size.


If the parameters are valid, the operator tuple_histo_rangetuple_histo_rangeTupleHistoRangeTupleHistoRangeTupleHistoRange returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

tuple_mintuple_minTupleMinTupleMinTupleMin, tuple_maxtuple_maxTupleMaxTupleMaxTupleMax

Possible Successors


See also

gray_histogray_histoGrayHistoGrayHistoGrayHisto, gray_histo_absgray_histo_absGrayHistoAbsGrayHistoAbsGrayHistoAbs, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangeGrayHistoRange