cf.eq

cf.eq(value, units=None)

Return an object for testing whether a variable is equal to the given value.

Parameters :

value

The value which a variable is to be compared with.

units : str or cf.Units, optional

If applicable, the units of value. 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.eq(5)
>>> c
<CF Comparison: x eq 5>
>>> c.evaluate(5)
True
>>> c.evaluate(4)
False