trace

Graph.trace(x, *, name=None)

Calculate the trace of an object. This can be a an array, a tensor, or a time-dependent function in the form of a Pwc or an Stf where values have at least two dimensions. The trace is calculated on the last two dimensions.

Parameters

• x (np.ndarray or Tensor or Pwc or Stf) – The object whose trace you want to calculate, $\mathop{\mathrm{Tr}}(x)$
• name (str or None , optional) – The name of the node. You can only provide a name if the object is not an Stf.

Returns

The trace of the last two dimension of the given matrix or matrix-valued function. Outputs will have two fewer dimensions.

Return type

Tensor or Pwc or Stf

SEE ALSO

Graph.einsum : Tensor contraction via Einstein summation convention.