Struct tensorflow_proto::xla::LayoutProto

pub struct LayoutProto {
    pub format: i32,
    pub minor_to_major: Vec<i64>,
    pub max_sparse_elements: i64,
    pub tiles: Vec<TileProto>,
    pub element_size_in_bits: i64,
    pub memory_space: i64,
}

A layout describes how the array is placed in (1D) memory space. This includes the minor-to-major ordering of dimensions within a shape.

Clients must specify the layouts of input Literals to the computation. Layouts specified in interior operations which take Shapes (for example, Convert) are ignored.

See the XLA documentation for more information on shapes and layouts.

LINT.IfChange

Fields

format: i32

The method used to store the data in memory. The format determines which of the other fields are used by the layout.

minor_to_major: Vec<i64>

Sequence of dimension numbers, from minor (fastest varying index) to major (slowest varying index). This field is required.

max_sparse_elements: i64

The maximum number of elements that can be stored for SPARSE formats. This can be used to determine the maximum size in bytes of arrays stored in memory. This field must be unset unless the format is SPARSE.

tiles: Vec<TileProto>

A sequence of tiles, starting from the tile that's applied first to the Shape.

TODO(b/119839262): implement tiling in each backend or add Unimplemented error.

element_size_in_bits: i64

Bit size of each element. If the size is bigger than what the element type requires, the value is stored in the least significant bits and the additional most significant bits are filled with 0's.

TODO(b/119839262): implement in each backend or add Unimplemented error.

memory_space: i64

Memory space where this array resides. The integer field is interpreted in a backend-specific manner.

Implementations

impl LayoutProto

pub fn format(&self) -> Format

Returns the enum value of format, or the default if the field is set to an invalid enum value.

pub fn set_format(&mut self, value: Format)

Sets format to the provided enum value.

Trait Implementations

impl Clone for LayoutProto

pub fn clone(&self) -> LayoutProto

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LayoutProto

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LayoutProto

pub fn default() -> Self

Returns the "default value" for a type.

impl Message for LayoutProto

pub fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

pub fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

pub fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<LayoutProto> for LayoutProto

pub fn eq(&self, other: &LayoutProto) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &LayoutProto) -> bool

This method tests for !=.

impl StructuralPartialEq for LayoutProto