cf.wi

cf.wi(value0, value1, units=None)

Return an object for testing whether a variable is within the given range.

Parameters :

value0 : object

The lower bound of the range which a variable is to be compared with.

value1 : object

The upper bound of the range which a variable is to be compared with.

units : str or cf.Units, optional

If applicable, the units of value0 and value1. By default, the same units as the variable being tested are assumed.

Returns :

out : cf.Comparison

A cf.Comparison object which will evaluate whether or not the comparison evaluates to True.

Examples

>>> c = cf.wi(5,7)
>>> c
<CF Comparison: x wi (5, 7)>
>>> c.evaluate(6)
True
>>> c.evaluate(4)
False