Array class append and push interfaces¶

What interfaces are these?¶

The append and push method interfaces append any value to the end of an array. These interfaces behave the same (append is similar to the Python built-in and the push interface is similar to the JavaScript).

Basic usage¶

The append and push methods require the first argument of the value.

import apysc as ap

ap.Stage()
arr: ap.Array[int] = ap.Array([1, 2])
arr.append(value=3)
assert arr == [1, 2, 3]

arr.push(value=4)
assert arr == [1, 2, 3, 4]

append 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] append(self, value: ~_ArrValue) -> None

[Interface summary]

Add any value to the end of this array. This method behaves the same push method.

[Parameters]

• value: *

  • Any value to append.

[Examples]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> arr: ap.Array = ap.Array([1, 2, 3])
>>> arr.append(4)
>>> arr
Array([1, 2, 3, 4])

push 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] push(self, value: ~_ArrValue) -> None

[Interface summary]

Add any value to the end of this array. This interface behaves the same as the append method.

[Parameters]

• value: *

  • Any value to append.

[Examples]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> arr: ap.Array = ap.Array([1, 2, 3])
>>> arr.push(4)
>>> arr
Array([1, 2, 3, 4])