assert_greater and assert_greater_equal interfaces¶

What interfaces are these?¶

The assert_greater function interface asserts a specified first value is greater than a specified second value.

Similarly, the assert_greater_equal function interface asserts a specified first value is greater than or equal to a specified second value.

See also¶

• JavaScript assertion interface basic behavior

Basic usage¶

The assert_greater and assert_greater_equal interfaces require the left and right arguments.

These arguments only accept numeric values, such as the Python built-in int, float, apysc Int, or Number value.

The msg argument is optional.

This interface displays a specified msg (message) argument to the browser console when an assertion fails.

import apysc as ap

stage: ap.Stage = ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
int_val_1: ap.Int = ap.Int(10)
int_val_2: ap.Int = ap.Int(9)
ap.assert_greater(left=int_val_1, right=int_val_2, msg="Assertion failed")

int_val_3: ap.Int = ap.Int(10)
ap.assert_greater_equal(left=int_val_1, right=int_val_3, msg="Assertion failed")

ap.save_overall_html(dest_dir_path="assert_greater_and_greater_equal_basic_usage_1/")

The following example fails an assertion and displays the Assertion failed message on the browser console:

import apysc as ap

stage: ap.Stage = ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
int_val_1: ap.Int = ap.Int(9)
int_val_2: ap.Int = ap.Int(10)
ap.assert_greater(left=int_val_1, right=int_val_2, msg="Assertion failed")

ap.save_overall_html(dest_dir_path="assert_greater_and_greater_equal_basic_usage_2/")

assert_greater API¶

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface signature] assert_greater(left: Union[int, float, apysc._type.int.Int, apysc._type.number.Number], right: Union[int, float, apysc._type.int.Int, apysc._type.number.Number], *, msg: str = '') -> None

[Interface summary]

JavaScript assertion interface for the greater than condition.

[Parameters]

• left: Union[int, float, Int, Number]

  • Left-side (greater) value to compare.

• right: Union[int, float, Int, Number]

  • Right-side (less) value to compare.

• msg: str, optional

  • Message to display when assertion failed.

[Examples]

>>> import apysc as ap
>>> int_val_1: ap.Int = ap.Int(10)
>>> int_val_2: ap.Int = ap.Int(9)
>>> ap.assert_greater(left=int_val_1, right=int_val_2)

assert_greater_equal API¶

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface signature] assert_greater_equal(left: Union[int, float, apysc._type.int.Int, apysc._type.number.Number], right: Union[int, float, apysc._type.int.Int, apysc._type.number.Number], *, msg: str = '') -> None

[Interface summary]

JavaScript assertion interface for the greater than or equal to condition.

[Parameters]

• left: Union[int, float, Int, Number]

  • Left-side (greater) value to compare.

• right: Union[int, float, Int, Number]

  • Right-side (less) value to compare.

• msg: str, optional

  • Message to display when assertion failed.

[Examples]

>>> import apysc as ap
>>> int_val_1: ap.Int = ap.Int(10)
>>> int_val_2: ap.Int = ap.Int(9)
>>> ap.assert_greater_equal(left=int_val_1, right=int_val_2)
>>> int_val_3: ap.Int = ap.Int(10)
>>> ap.assert_greater_equal(left=int_val_1, right=int_val_3)