buffer

Provide internal nodes that host compilers can target for the buffer/view substrate without defining a user-facing array API.

Classes:

• BufferOwnerType –
• BufferViewDescriptor –
• BufferViewIndex –
• BufferViewRelease –
• BufferViewRetain –
• BufferViewStore –
• BufferViewType –
• BufferViewWrite –

BufferOwnerType

BufferOwnerType()

Bases: OpaqueHandleType

Methods:

• get_struct –

Source code in src/irx/astx/buffer.py

def __init__(self) -> None:
    """
    title: Initialize the buffer owner handle type.
    """
    super().__init__("irx_buffer_owner_handle")

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/ffi.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Build one repr structure for an opaque-handle type.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    return self._prepare_struct(
        f"OPAQUE-HANDLE[{self.handle_name}]",
        self.handle_name,
        simplified,
    )

BufferViewDescriptor

BufferViewDescriptor(
    metadata: BufferViewMetadata,
    element_type: DataType | None = None,
)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/buffer.py

def __init__(
    self,
    metadata: BufferViewMetadata,
    element_type: astx.DataType | None = None,
) -> None:
    """
    title: Initialize one buffer view descriptor.
    parameters:
      metadata:
        type: BufferViewMetadata
      element_type:
        type: astx.DataType | None
    """
    super().__init__()
    self.metadata = metadata
    self.type_ = BufferViewType(element_type)

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/buffer.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the structured representation.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    _ = simplified
    return self._prepare_struct(
        "BufferViewDescriptor",
        cast(astx.base.ReprStruct, repr(self.metadata)),
        simplified,
    )

BufferViewIndex

BufferViewIndex(base: AST, indices: Sequence[AST])

Bases: DataType

Reads one scalar element by computing offset_bytes plus the sum of index*stride byte offsets over the canonical buffer view descriptor. attributes: base: type: astx.AST indices: type: list[astx.AST] type_: type: astx.DataType

Methods:

• get_struct –

Source code in src/irx/astx/buffer.py

def __init__(
    self,
    base: astx.AST,
    indices: Sequence[astx.AST],
) -> None:
    """
    title: Initialize one low-level indexed read.
    parameters:
      base:
        type: astx.AST
      indices:
        type: Sequence[astx.AST]
    """
    super().__init__()
    if not indices:
        raise ValueError(
            "buffer view indexing requires at least one index"
        )
    self.base = base
    self.indices = list(indices)
    self.type_ = AnyType()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/buffer.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the structured representation.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    value = {
        "base": self.base.get_struct(simplified),
        "indices": [
            index.get_struct(simplified) for index in self.indices
        ],
    }
    return self._prepare_struct(
        "BufferViewIndex",
        cast(astx.base.ReprStruct, value),
        simplified,
    )

BufferViewRelease

BufferViewRelease(view: AST)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/buffer.py

def __init__(self, view: astx.AST) -> None:
    """
    title: Initialize one buffer release helper call.
    parameters:
      view:
        type: astx.AST
    """
    super().__init__()
    self.view = view
    self.type_ = astx.Int32()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/buffer.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the structured representation.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    return self._prepare_struct(
        "BufferViewRelease",
        self.view.get_struct(simplified),
        simplified,
    )

BufferViewRetain

BufferViewRetain(view: AST)

Bases: DataType

Methods:

• get_struct –

Source code in src/irx/astx/buffer.py

def __init__(self, view: astx.AST) -> None:
    """
    title: Initialize one buffer retain helper call.
    parameters:
      view:
        type: astx.AST
    """
    super().__init__()
    self.view = view
    self.type_ = astx.Int32()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/buffer.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the structured representation.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    return self._prepare_struct(
        "BufferViewRetain",
        self.view.get_struct(simplified),
        simplified,
    )

BufferViewStore

BufferViewStore(
    base: AST, indices: Sequence[AST], value: AST
)

Bases: DataType

Stores one scalar element by computing the canonical descriptor element address. This is not a user-facing array mutation API. attributes: base: type: astx.AST indices: type: list[astx.AST] value: type: astx.AST type_: type: astx.Int32

Methods:

• get_struct –

Source code in src/irx/astx/buffer.py

def __init__(
    self,
    base: astx.AST,
    indices: Sequence[astx.AST],
    value: astx.AST,
) -> None:
    """
    title: Initialize one low-level indexed store.
    parameters:
      base:
        type: astx.AST
      indices:
        type: Sequence[astx.AST]
      value:
        type: astx.AST
    """
    super().__init__()
    if not indices:
        raise ValueError(
            "buffer view indexing requires at least one index"
        )
    self.base = base
    self.indices = list(indices)
    self.value = value
    self.type_ = astx.Int32()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/buffer.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the structured representation.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    value = {
        "base": self.base.get_struct(simplified),
        "indices": [
            index.get_struct(simplified) for index in self.indices
        ],
        "value": self.value.get_struct(simplified),
    }
    return self._prepare_struct(
        "BufferViewStore",
        cast(astx.base.ReprStruct, value),
        simplified,
    )

BufferViewType

BufferViewType(element_type: DataType | None = None)

Bases: AnyType

Source code in src/irx/astx/buffer.py

def __init__(self, element_type: astx.DataType | None = None) -> None:
    """
    title: Initialize a buffer view descriptor type.
    parameters:
      element_type:
        type: astx.DataType | None
    """
    super().__init__()
    self.element_type = element_type

BufferViewWrite

BufferViewWrite(
    view: AST, value: AST, *, byte_offset: int = 0
)

Bases: DataType

Writes one 8-bit integer at offset_bytes + byte_offset. This is not a generic typed element store or user-facing array mutation API. attributes: view: type: astx.AST value: type: astx.AST byte_offset: type: int type_: type: astx.Int32

Methods:

• get_struct –

Source code in src/irx/astx/buffer.py

def __init__(
    self,
    view: astx.AST,
    value: astx.AST,
    *,
    byte_offset: int = 0,
) -> None:
    """
    title: Initialize one low-level view write.
    parameters:
      view:
        type: astx.AST
      value:
        type: astx.AST
      byte_offset:
        type: int
    """
    super().__init__()
    self.view = view
    self.value = value
    self.byte_offset = byte_offset
    self.type_ = astx.Int32()

get_struct

get_struct(simplified: bool = False) -> ReprStruct

Source code in src/irx/astx/buffer.py

def get_struct(self, simplified: bool = False) -> astx.base.ReprStruct:
    """
    title: Return the structured representation.
    parameters:
      simplified:
        type: bool
    returns:
      type: astx.base.ReprStruct
    """
    value = {
        "view": self.view.get_struct(simplified),
        "value": self.value.get_struct(simplified),
        "byte_offset": self.byte_offset,
    }
    return self._prepare_struct(
        "BufferViewWrite",
        cast(astx.base.ReprStruct, value),
        simplified,
    )