check-vector-isEqual: How does the input relate to a value?

In steinbaugh/goalie: Assertive Check Functions

How does the input relate to a value?

Description

How does the input relate to a value?

Usage

isEqualTo(x, y)

isNotEqualTo(x, y)

isGreaterThan(x, y)

isGreaterThanOrEqualTo(x, y)

isLessThan(x, y)

isLessThanOrEqualTo(x, y)

allAreEqualTo(x, y)

allAreNotEqualTo(x, y)

allAreGreaterThan(x, y)

allAreGreaterThanOrEqualTo(x, y)

allAreLessThan(x, y)

allAreLessThanOrEqualTo(x, y)

Arguments

x	Object.
y	Object.

Value

TRUE on success; FALSE on failure, with cause set.

Functions

• isEqualTo(): Vectorized.

• isNotEqualTo(): Vectorized.

• isGreaterThan(): Vectorized.

• isGreaterThanOrEqualTo(): Vectorized.

• isLessThan(): Vectorized.

• isLessThanOrEqualTo(): Vectorized.

• allAreEqualTo(): Scalar.

• allAreNotEqualTo(): Scalar.

• allAreGreaterThan(): Scalar.

• allAreGreaterThanOrEqualTo(): Scalar.

• allAreLessThan(): Scalar.

• allAreLessThanOrEqualTo(): Scalar.

Note

Updated 2023-10-02.

See Also

• Primitive operators: ==, >, >=, <, <=.

• assertive.numbers::is_equal_to().

• assertive.numbers::is_not_equal_to().

• assertive.numbers::is_greater_than().

• assertive.numbers::is_greater_than_or_equal_to().

• assertive.numbers::is_less_than().

• assertive.numbers::is_less_than_or_equal_to().

Examples

## TRUE ====
isEqualTo(x = 1L, y = 1)
isNotEqualTo(x = 2, y = 1)
isGreaterThan(x = 1, y = 0)
isGreaterThanOrEqualTo(x = seq_len(2), y = 1)
isLessThan(x = -1, y = 0)
isLessThanOrEqualTo(x = seq_len(2), y = 3)

## FALSE ====
isEqualTo(x = seq_len(2), y = 1)

steinbaugh/goalie documentation built on Jan. 17, 2024, 5:16 p.m.