org.bytedeco.tensorflow

Class MatrixDiagPartV2

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tensorflow.MatrixDiagPartV2

All Implemented Interfaces:

AutoCloseable

@Namespace(value="tensorflow::ops")
 @NoOffset
 @Properties(inherit=tensorflow.class)
public class MatrixDiagPartV2
extends Pointer

Returns the batched diagonal part of a batched tensor. Returns a tensor with the k[0]-th to k[1]-th diagonals of the batched input. Assume input has r dimensions [I, J, ..., L, M, N]. Let max_diag_len be the maximum length among all diagonals to be extracted, max_diag_len = min(M + min(k[1], 0), N + min(-k[0], 0)) Let num_diags be the number of diagonals to extract, num_diags = k[1] - k[0] + 1. If num_diags == 1, the output tensor is of rank r - 1 with shape [I, J, ..., L, max_diag_len] and values:

  diagonal[i, j, ..., l, n]
    = input[i, j, ..., l, n+y, n+x] ; when 0 <= n-y < M and 0 <= n-x < N,
      0                             ; otherwise.
  

where y = max(-k[1], 0), x = max(k[1], 0). Otherwise, the output tensor has rank r with dimensions [I, J, ..., L, num_diags, max_diag_len] with values:

  diagonal[i, j, ..., l, m, n]
    = input[i, j, ..., l, n+y, n+x] ; when 0 <= n-y < M and 0 <= n-x < N,
      0                             ; otherwise.
  

where d = k[1] - m, y = max(-d, 0), and x = max(d, 0). The input must be at least a matrix. For example:

  input = np.array([[[1, 2, 3, 4],  # Input shape: (2, 3, 4)
                     [5, 6, 7, 8],
                     [9, 8, 7, 6]],
                    [[5, 4, 3, 2],
                     [1, 2, 3, 4],
                     [5, 6, 7, 8]]])
 
  # A main diagonal from each batch.
  tf.matrix_diag_part(input) ==> [[1, 6, 7],  # Output shape: (2, 3)
                                  [5, 2, 7]]
 
  # A superdiagonal from each batch.
  tf.matrix_diag_part(input, k = 1)
    ==> [[2, 7, 6],  # Output shape: (2, 3)
         [4, 3, 8]]
 
  # A tridiagonal band from each batch.
  tf.matrix_diag_part(input, k = (-1, 1))
    ==> [[[2, 7, 6],  # Output shape: (2, 3, 3)
          [1, 6, 7],
          [5, 8, 0]],
         [[4, 3, 8],
          [5, 2, 7],
          [1, 6, 0]]]
 
  # Padding = 9
  tf.matrix_diag_part(input, k = (1, 3), padding = 9)
    ==> [[[4, 9, 9],  # Output shape: (2, 3, 3)
          [3, 8, 9],
          [2, 7, 6]],
         [[2, 9, 9],
          [3, 4, 9],
          [4, 3, 8]]]
  

Arguments: * scope: A Scope object * input: Rank r tensor where r >= 2. * k: Diagonal offset(s). Positive value means superdiagonal, 0 refers to the main diagonal, and negative value means subdiagonals. k can be a single integer (for a single diagonal) or a pair of integers specifying the low and high ends of a matrix band. k[0] must not be larger than k[1]. * padding_value: The value to fill the area outside the specified diagonal band with. Default is 0. Returns: * Output: The extracted diagonal(s).

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
MatrixDiagPartV2(Pointer p) Pointer cast constructor.
MatrixDiagPartV2(Scope scope, Input input, Input k, Input padding_value)

Method Summary

Modifier and Type	Method and Description
Input	asInput()
Output	asOutput()
Output	diagonal()
MatrixDiagPartV2	diagonal(Output setter)
Node	node()
Operation	operation()
MatrixDiagPartV2	operation(Operation setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MatrixDiagPartV2

public MatrixDiagPartV2(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

MatrixDiagPartV2

public MatrixDiagPartV2(@Const @ByRef
                        Scope scope,
                        @ByVal
                        Input input,
                        @ByVal
                        Input k,
                        @ByVal
                        Input padding_value)

Method Detail

asOutput

@ByVal
 @Name(value="operator tensorflow::Output")
public Output asOutput()

asInput

@ByVal
 @Name(value="operator tensorflow::Input")
public Input asInput()

node

public Node node()

operation

@ByRef
public Operation operation()

operation

public MatrixDiagPartV2 operation(Operation setter)

diagonal

@ByRef
public Output diagonal()

diagonal

public MatrixDiagPartV2 diagonal(Output setter)