# tff.framework.Struct

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/federated/blob/v0.87.0 Version 2.0, January 2004 Licensed under the Apache License, Version 2.0 (the) |

A struct with named or unnamed elements in TFF's internal language.

Inherits From: [`ComputationBuildingBlock`](https://www.tensorflow.org/federated/api_docs/python/tff/framework/ComputationBuildingBlock), [`TypedObject`](https://www.tensorflow.org/federated/api_docs/python/tff/TypedObject), [`Struct`](https://www.tensorflow.org/federated/api_docs/python/tff/structure/Struct)

    tff.framework.Struct(
        elements, container_type=None
    )

The concise notation for structs is `<name_1=value_1, ...., name_n=value_n>`
for structs with named elements, `<value_1, ..., value_n>` for structs with
unnamed elements, or a mixture of these for structs with some named and some
unnamed elements, where `name_k` are the names, and `value_k` are the value
expressions.

For example, a lambda expression that applies `fn` to elements of 2-structs
pointwise could be represented as `(arg -> <fn(arg[0]),fn(arg[1])>)`.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `elements` | The elements of the struct, supplied as a list of (name, value) pairs, where 'name' can be None in case the corresponding element is not named and only accessible via an index (see also [`structure.Struct`](https://www.tensorflow.org/federated/api_docs/python/tff/structure/Struct)). |
| `container_type` | An optional Python container type to associate with the struct. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `TypeError` | if arguments are of the wrong types. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `proto` | Returns a serialized form of this object as a pb.Computation instance. |
| `type_signature` | Returns the TFF type of this object (an instance of [`tff.Type`](https://www.tensorflow.org/federated/api_docs/python/tff/types/Type)). |

<br />

## Methods

### `children`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    children() -> Iterator[https://www.tensorflow.org/federated/api_docs/python/tff/framework/ComputationBuildingBlock]

Returns an iterator yielding immediate child building blocks.

### `compact_representation`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    compact_representation()

Returns the compact string representation of this building block.

### `formatted_representation`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    formatted_representation()

Returns the formatted string representation of this building block.

### `from_proto`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    @classmethod
    from_proto(
        computation_proto: pb.Computation
    ) -> 'Struct'

Returns an instance of a derived class based on 'computation_proto'.

<br />

<br />

<br />

| Args ||
|---|---|
| `computation_proto` | An instance of pb.Computation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| An instance of a class that implements 'ComputationBuildingBlock' and that contains the deserialized logic from in 'computation_proto'. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `NotImplementedError` | if computation_proto contains a kind of computation for which deserialization has not been implemented yet. |
| `ValueError` | if deserialization failed due to the argument being invalid. |

<br />

### `named`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    @classmethod
    named(
        **kwargs
    ) -> 'Struct'

Constructs a new `Struct` with all named elements.

### `structural_representation`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    structural_representation()

Returns the structural string representation of this building block.

### `unnamed`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    @classmethod
    unnamed(
        *args
    ) -> 'Struct'

Constructs a new `Struct` with all unnamed elements.

### `__eq__`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    __eq__(
        other: object
    ) -> bool

Return self==value.

### `__getitem__`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    __getitem__(
        key: Union[int, str, slice]
    ) -> _T

### `__iter__`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    __iter__() -> Iterator[_T]

### `__len__`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    __len__() -> int

### `__ne__`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    __ne__(
        other: object
    ) -> bool

Return self!=value.