Array class insert and insert_at interfaces¶

What interfaces are these?¶

The insert and insert_at method interfaces append any value at the specified index. Both interfaces behave the same way (the insert is the alias of the insert_at).

Basic usage¶

The insert and insert_at have the same argument, the index and value. The index argument accepts an int and Int value.

import apysc as ap

ap.Stage()
arr: ap.Array[int] = ap.Array([1, 4])
arr.insert(index=1, value=2)
assert arr == [1, 2, 4]

index: ap.Int = ap.Int(2)
arr.insert_at(index=index, value=3)
assert arr == [1, 2, 3, 4]

insert 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] insert(self, index: Union[int, apysc._type.int.Int], value: ~_ArrValue) -> None

[Interface summary]

Insert value to this array at a specified index. This interface behaves in the same insert_at method.

[Parameters]

• index: Int or int

  • Index to append value.

• value: *

  • Any value to append.

[Examples]

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

insert_at 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] insert_at(self, *, index: Union[int, apysc._type.int.Int], value: ~_ArrValue) -> None

[Interface summary]

Insert value to this array at a specified index. This interface behaves in the same insert method.

[Parameters]

• index: Int or int

  • Index to append value.

• value: *

  • Any value to append.

[Examples]

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