R/exports-numbers.R

In assertive: Readable Check Functions to Ensure Code Integrity

# From assertive.numbers is-divisible-by.R, assert-is-divisible-by.R

#' Is the input divisible by a number?
#' 
#' See \code{\link[assertive.numbers]{is_divisible_by}}.
#' @name is_divisible_by
#' @aliases is_even is_odd assert_all_are_divisible_by assert_any_are_divisible_by assert_all_are_even assert_any_are_even assert_all_are_odd assert_any_are_odd
#' @export is_divisible_by
#' @export is_even
#' @export is_odd
#' @export assert_all_are_divisible_by
#' @export assert_any_are_divisible_by
#' @export assert_all_are_even
#' @export assert_any_are_even
#' @export assert_all_are_odd
#' @export assert_any_are_odd
NULL

# From assertive.numbers is-equal-to.R, assert-is-equal-to.R

#' How does the input relate to a value?
#' 
#' See \code{\link[assertive.numbers]{is_equal_to}}.
#' @name is_equal_to
#' @aliases is_not_equal_to is_greater_than is_greater_than_or_equal_to is_less_than is_less_than_or_equal_to assert_all_are_equal_to assert_any_are_equal_to assert_all_are_not_equal_to assert_any_are_not_equal_to assert_all_are_greater_than assert_any_are_greater_than assert_all_are_greater_than_or_equal_to assert_any_are_greater_than_or_equal_to assert_all_are_less_than assert_any_are_less_than assert_all_are_less_than_or_equal_to assert_any_are_less_than_or_equal_to
#' @export is_equal_to
#' @export is_not_equal_to
#' @export is_greater_than
#' @export is_greater_than_or_equal_to
#' @export is_less_than
#' @export is_less_than_or_equal_to
#' @export assert_all_are_equal_to
#' @export assert_any_are_equal_to
#' @export assert_all_are_not_equal_to
#' @export assert_any_are_not_equal_to
#' @export assert_all_are_greater_than
#' @export assert_any_are_greater_than
#' @export assert_all_are_greater_than_or_equal_to
#' @export assert_any_are_greater_than_or_equal_to
#' @export assert_all_are_less_than
#' @export assert_any_are_less_than
#' @export assert_all_are_less_than_or_equal_to
#' @export assert_any_are_less_than_or_equal_to
NULL

# From assertive.numbers is-in-range.R, assert-is-in-range.R

#' Is the input in range?
#' 
#' See \code{\link[assertive.numbers]{is_in_range}}.
#' @name is_in_range
#' @aliases is_in_closed_range is_in_left_open_range is_in_open_range is_in_right_open_range is_negative is_non_negative is_non_positive is_percentage is_positive is_proportion assert_all_are_in_range assert_any_are_in_range assert_all_are_in_closed_range assert_any_are_in_closed_range assert_all_are_in_left_open_range assert_any_are_in_left_open_range assert_all_are_in_open_range assert_any_are_in_open_range assert_all_are_in_right_open_range assert_any_are_in_right_open_range assert_all_are_negative assert_any_are_negative assert_all_are_non_negative assert_any_are_non_negative assert_all_are_non_positive assert_any_are_non_positive assert_all_are_percentages assert_any_are_percentages assert_all_are_positive assert_any_are_positive assert_all_are_proportions assert_any_are_proportions 
#' @export is_in_range
#' @export is_in_closed_range
#' @export is_in_left_open_range
#' @export is_in_open_range
#' @export is_in_right_open_range
#' @export is_negative
#' @export is_non_negative
#' @export is_non_positive
#' @export is_percentage
#' @export is_positive
#' @export is_proportion
#' @export assert_all_are_in_range
#' @export assert_any_are_in_range
#' @export assert_all_are_in_closed_range
#' @export assert_any_are_in_closed_range
#' @export assert_all_are_in_left_open_range
#' @export assert_any_are_in_left_open_range
#' @export assert_all_are_in_open_range
#' @export assert_any_are_in_open_range
#' @export assert_all_are_in_right_open_range
#' @export assert_any_are_in_right_open_range
#' @export assert_all_are_negative
#' @export assert_any_are_negative
#' @export assert_all_are_non_negative
#' @export assert_any_are_non_negative
#' @export assert_all_are_non_positive
#' @export assert_any_are_non_positive
#' @export assert_all_are_percentages
#' @export assert_any_are_percentages
#' @export assert_all_are_positive
#' @export assert_any_are_positive
#' @export assert_all_are_proportions
#' @export assert_any_are_proportions
NULL

# From assertive.numbers is-infinity-nan.R, assert-is-infinity-nan.R

#' Are the inputs (in)finite?
#' 
#' See \code{\link[assertive.numbers]{is_finite}}.
#' @name is_finite
#' @aliases is_infinite is_negative_infinity is_positive_infinity assert_all_are_finite assert_any_are_finite assert_all_are_infinite assert_any_are_infinite assert_all_are_negative_infinity assert_any_are_negative_infinity assert_all_are_positive_infinity assert_any_are_positive_infinity
#' @export is_finite
#' @export is_infinite
#' @export is_negative_infinity
#' @export is_positive_infinity
#' @export assert_all_are_finite
#' @export assert_any_are_finite
#' @export assert_all_are_infinite
#' @export assert_any_are_infinite
#' @export assert_all_are_negative_infinity
#' @export assert_any_are_negative_infinity
#' @export assert_all_are_positive_infinity
#' @export assert_any_are_positive_infinity
NULL

#' Is the input (not) NaN?
#' 
#' See \code{\link[assertive.numbers]{is_nan}}.
#' @name is_nan
#' @aliases is_not_nan assert_all_are_nan assert_any_are_nan assert_all_are_not_nan assert_any_are_not_nan
#' @export is_nan
#' @export is_not_nan
#' @export assert_all_are_nan
#' @export assert_any_are_nan
#' @export assert_all_are_not_nan
#' @export assert_any_are_not_nan
NULL

# From assertive.numbers is-real-imaginary.R, assert-is-real-imaginary.R

#' Is the input real/imaginary?
#' 
#' See \code{\link[assertive.numbers]{is_real}}.
#' @name is_real
#' @aliases is_imaginary assert_all_are_real assert_any_are_real assert_all_are_imaginary assert_any_are_imaginary
#' @export is_real 
#' @export is_imaginary
#' @export assert_all_are_real
#' @export assert_any_are_real
#' @export assert_all_are_imaginary
#' @export assert_any_are_imaginary
NULL

# From assertive.numbers is-whole-number.R, assert-is-whole-numbery.R

#' Is the input a whole number?
#' 
#' See \code{\link[assertive.numbers]{is_whole_number}}.
#' @name is_whole_number
#' @aliases assert_all_are_whole_numbers assert_any_are_whole_numbers assert_all_numbers_are_whole_numbers assert_any_numbers_are_whole_numbers
#' @export is_whole_number
#' @export assert_all_are_whole_numbers
#' @export assert_any_are_whole_numbers
#' @export assert_all_numbers_are_whole_numbers
#' @export assert_any_numbers_are_whole_numbers
NULL