org.bytedeco.ngraph

Class Node

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ngraph.Node

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

Constant, Op

@Namespace(value="ngraph")
 @NoOffset
 @Properties(inherit=ngraph.class)
public class Node
extends Pointer

Nodes are the backbone of the graph of Value dataflow. Every node has zero or more nodes as arguments and one value, which is either a tensor or a (possibly empty) tuple of values.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static long	placement_invalid

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Node(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	add_control_dependency(Node node) This node cannot execute until node executes
void	add_node_control_dependencies(Node source_node) This node absorbs the control dependencies of source_node
void	add_node_control_dependents(Node source_node) This node becomes a dependent of every node dependent on source_node
void	add_provenance_group_member(Node node) \brief Add node to additional nodes that receive tags
Node	add_provenance_group_members_above(NodeOutputVector base) \brief Add all nodes between this node and nodes in base as additional nodes to receive provenance tags.
void	add_provenance_tag(BytePointer tag)
void	add_provenance_tag(String tag)
void	clear_control_dependencies() Remove all dependencies from this node
void	clear_control_dependents() Remove this node as a dependency from all dependent nodes
Node	copy_with_new_inputs(NodeOutputVector new_args)
Node	copy_with_new_inputs(NodeOutputVector inputs, NodeVector control_dependencies)
void	delayed_validate_and_infer_types()
BytePointer	description() \brief Get the string name for the type of the node, such as Add or Multiply.
Node	get_argument(long index)
NodeVector	get_arguments()
NodeVector	get_control_dependencies() Get control dependencies registered on the node
PointerPointer	get_control_dependents() Get nodes dependent on this node
Node	get_default_value()
Type	get_element_type() Checks that there is exactly one output and returns its element type
BytePointer	get_friendly_name() \brief Gets the friendly name for a node.
Type	get_input_element_type(long i) Returns the element type of input i
PartialShape	get_input_partial_shape(long i) Returns the partial shape of input i
Shape	get_input_shape(long i) Returns the shape of input i
long	get_input_size() Returns the number of inputs for the op
BytePointer	get_input_tensor_name(long i) Returns the tensor name for input i
long	get_instance_id()
BytePointer	get_name() \brief Get the unique name of the node.
Node	get_output_as_single_output_node(long i)
Node	get_output_as_single_output_node(long i, boolean for_get_output_element)
Type	get_output_element_type(long i) Returns the element type for output i
DescriptorInputVector	get_output_inputs(long i) Returns the set of inputs using output i
PartialShape	get_output_partial_shape(long i) Returns the partial shape for output i
Shape	get_output_shape(long i) Returns the shape for output i
long	get_output_size() Returns the number of outputs from the node.
BytePointer	get_output_tensor_name(long i) Returns the tensor name for output i
DescriptorTensor	get_output_tensor_ptr() Checks that there is exactly one output and returns its tensor.
DescriptorTensor	get_output_tensor_ptr(long i) Returns the tensor of output i
DescriptorTensor	get_output_tensor() Checks that there is exactly one output and returns its tensor.
DescriptorTensor	get_output_tensor(long i) Returns the tensor for output i
long	get_placement_index() Get device placement
int	get_placement() Get device placement
Shape	get_shape() Checks that there is exactly one output and returns its shape
NodeVector	get_users()
NodeVector	get_users(boolean check_is_used) Get all the nodes that uses the current node
long	get_version()
boolean	has_state()
NodeOutput	input_value(long input_index)
NodeOutputVector	input_values()
NodeInput	input(long input_index)
NodeInputVector	inputs()
boolean	is_commutative()
boolean	is_constant()
boolean	is_dynamic()
boolean	is_null()
boolean	is_op()
boolean	is_output()
boolean	is_parameter()
boolean	is_same_op_type(Node node) Return true if this has the same implementing class as node.
boolean	lessThan(Node other) Use instance ids for comparison instead of memory addresses to improve determinism
void	merge_provenance_tags_from(Node source)
NodeOutput	output(long output_index)
NodeOutputVector	outputs()
static long	placement_invalid()
void	remove_control_dependency(Node node) Remove the dependency of this node on node
void	remove_provenance_tag(BytePointer tag) \brief Adds tag_set to this node and all intermediate nodes above base
void	remove_provenance_tag(String tag)
void	revalidate_and_infer_types()
void	set_argument(long _position, NodeOutput argument) Sets/replaces the arguments with new arguments.
void	set_arguments(NodeOutputVector arguments) Sets/replaces the arguments with new arguments.
void	set_arguments(NodeVector arguments) Sets/replaces the arguments with new arguments.
void	set_friendly_name(BytePointer name) \brief Sets a friendly name for a node.
void	set_friendly_name(String name)
void	set_input_is_relevant_to_shape(long i)
void	set_input_is_relevant_to_shape(long i, boolean relevant) \brief Marks an input as being relevant or irrelevant to the output shapes of this node.
void	set_input_is_relevant_to_value(long i)
void	set_input_is_relevant_to_value(long i, boolean relevant) \brief Marks an input as being relevant or irrelevant to the output values of this node.
void	set_output_size(long output_size) Sets the number of outputs
void	set_output_type(long i, Type element_type, PartialShape pshape)
void	set_placement_index(long placement) Set device placement
void	set_placement(int placement) Set device placement
Pointer	write_long_description(Pointer arg0)
Pointer	write_short_description(Pointer arg0)

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

Field Detail

placement_invalid

public static final long placement_invalid

Constructor Detail

Node

public Node(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

set_arguments

public void set_arguments(@Const @ByRef
                          NodeVector arguments)

Sets/replaces the arguments with new arguments.

set_arguments

public void set_arguments(@Cast(value="const ngraph::OutputVector*") @ByRef
                          NodeOutputVector arguments)

Sets/replaces the arguments with new arguments.

set_argument

public void set_argument(@Cast(value="size_t")
                         long _position,
                         @Const @ByRef
                         NodeOutput argument)

Sets/replaces the arguments with new arguments.

set_output_size

public void set_output_size(@Cast(value="size_t")
                            long output_size)

Sets the number of outputs

revalidate_and_infer_types

public void revalidate_and_infer_types()

delayed_validate_and_infer_types

public void delayed_validate_and_infer_types()

description

@StdString
public BytePointer description()

\brief Get the string name for the type of the node, such as Add or Multiply. The class name, must not contain spaces as it is used for codegen.

Returns:

A const reference to the node's type name

get_name

@StdString
public BytePointer get_name()

\brief Get the unique name of the node.

Returns:

A const reference to the node's unique name.

set_friendly_name

public void set_friendly_name(@StdString
                              BytePointer name)

\brief Sets a friendly name for a node. This does not overwrite the unique name of the node and is retrieved via get_friendly_name(). Used mainly for debugging. The friendly name may be set exactly once.

Parameters:

name - is the friendly name to set

set_friendly_name

public void set_friendly_name(@StdString
                              String name)

get_friendly_name

@StdString
public BytePointer get_friendly_name()

\brief Gets the friendly name for a node. If no friendly name has been set via set_friendly_name then the node's unique name is returned.

Returns:

A const reference to the node's friendly name.

is_same_op_type

@Cast(value="bool")
public boolean is_same_op_type(@Const @SharedPtr @ByRef
                                                   Node node)

Return true if this has the same implementing class as node. This will be used by the pattern matcher when comparing a pattern graph against the graph.

set_input_is_relevant_to_shape

public void set_input_is_relevant_to_shape(@Cast(value="size_t")
                                           long i,
                                           @Cast(value="bool")
                                           boolean relevant)

\brief Marks an input as being relevant or irrelevant to the output shapes of this node.

Parameters:

i - The index of the input to mark as relevant or irrelevant.

relevant - true if the input is relevant to output shapes, false otherwise. This is used by the shape specialization pass to know which nodes must be statically evaluated in order to complete shape specialization. (For example, the shape input of DynReshape must be evaluated statically in order for the output shape to be determined.) By default, all inputs are marked as shape-irrelevant. Overrides of validate_and_infer_types should call this function to mark shape-relevant inputs.

set_input_is_relevant_to_shape

public void set_input_is_relevant_to_shape(@Cast(value="size_t")
                                           long i)

set_input_is_relevant_to_value

public void set_input_is_relevant_to_value(@Cast(value="size_t")
                                           long i,
                                           @Cast(value="bool")
                                           boolean relevant)

\brief Marks an input as being relevant or irrelevant to the output values of this node.

Parameters:

i - The index of the input to mark as relevant or irrelevant.

relevant - true if the input is relevant to output values, false otherwise. This is used by the shape specialization pass to cut short evaluation in cases where an input value does not actually have any effect on the output value of the node. (As of this writing, the only example of this is ShapeOf.) By default, all inputs are marked as value-relevant. Overrides of validate_and_infer_types should call this function to mark value-irrelevant inputs.

set_input_is_relevant_to_value

public void set_input_is_relevant_to_value(@Cast(value="size_t")
                                           long i)

set_output_type

public void set_output_type(@Cast(value="size_t")
                            long i,
                            @Const @ByRef
                            Type element_type,
                            @Const @ByRef
                            PartialShape pshape)

is_parameter

@Cast(value="bool")
public boolean is_parameter()

is_output

@Cast(value="bool")
public boolean is_output()

is_constant

@Cast(value="bool")
public boolean is_constant()

is_null

@Cast(value="bool")
public boolean is_null()

is_op

@Cast(value="bool")
public boolean is_op()

is_commutative

@Cast(value="bool")
public boolean is_commutative()

is_dynamic

@Cast(value="bool")
public boolean is_dynamic()

has_state

@Cast(value="bool")
public boolean has_state()

get_instance_id

@Cast(value="size_t")
public long get_instance_id()

write_short_description

@Cast(value="std::ostream*")
 @ByRef
public Pointer write_short_description(@Cast(value="std::ostream*") @ByRef
                                                                            Pointer arg0)

write_long_description

@Cast(value="std::ostream*")
 @ByRef
public Pointer write_long_description(@Cast(value="std::ostream*") @ByRef
                                                                           Pointer arg0)

get_control_dependencies

@Const
 @ByRef
public NodeVector get_control_dependencies()

Get control dependencies registered on the node

get_control_dependents

@Cast(value="ngraph::Node**")
 @StdVector
public PointerPointer get_control_dependents()

Get nodes dependent on this node

add_control_dependency

public void add_control_dependency(@SharedPtr @ByVal
                                   Node node)

This node cannot execute until node executes

remove_control_dependency

public void remove_control_dependency(@SharedPtr @ByVal
                                      Node node)

Remove the dependency of this node on node

clear_control_dependencies

public void clear_control_dependencies()

Remove all dependencies from this node

clear_control_dependents

public void clear_control_dependents()

Remove this node as a dependency from all dependent nodes

add_node_control_dependencies

public void add_node_control_dependencies(@SharedPtr @ByVal
                                          Node source_node)

This node absorbs the control dependencies of source_node

add_node_control_dependents

public void add_node_control_dependents(@SharedPtr @ByVal
                                        Node source_node)

This node becomes a dependent of every node dependent on source_node

get_output_size

@Cast(value="size_t")
public long get_output_size()

Returns the number of outputs from the node.

get_output_element_type

@Const
 @ByRef
public Type get_output_element_type(@Cast(value="size_t")
                                                   long i)

Returns the element type for output i

get_element_type

@Const
 @ByRef
public Type get_element_type()

Checks that there is exactly one output and returns its element type

get_output_shape

@Const
 @ByRef
public Shape get_output_shape(@Cast(value="size_t")
                                             long i)

Returns the shape for output i

get_output_partial_shape

@Const
 @ByRef
public PartialShape get_output_partial_shape(@Cast(value="size_t")
                                                            long i)

Returns the partial shape for output i

get_output_as_single_output_node

@SharedPtr
 @ByVal
public Node get_output_as_single_output_node(@Cast(value="size_t")
                                                                long i,
                                                                @Cast(value="bool")
                                                                boolean for_get_output_element)

get_output_as_single_output_node

@SharedPtr
 @ByVal
public Node get_output_as_single_output_node(@Cast(value="size_t")
                                                                long i)

get_shape

@Const
 @ByRef
public Shape get_shape()

Checks that there is exactly one output and returns its shape

get_output_tensor

@ByRef
public DescriptorTensor get_output_tensor(@Cast(value="size_t")
                                                 long i)

Returns the tensor for output i

get_output_tensor_name

@StdString
public BytePointer get_output_tensor_name(@Cast(value="size_t")
                                                     long i)

Returns the tensor name for output i

get_output_tensor

@ByRef
public DescriptorTensor get_output_tensor()

Checks that there is exactly one output and returns its tensor.

get_output_tensor_ptr

@SharedPtr
 @ByVal
public DescriptorTensor get_output_tensor_ptr(@Cast(value="size_t")
                                                                 long i)

Returns the tensor of output i

get_output_tensor_ptr

@SharedPtr
 @ByVal
public DescriptorTensor get_output_tensor_ptr()

Checks that there is exactly one output and returns its tensor.

get_output_inputs

@Const
 @ByRef
public DescriptorInputVector get_output_inputs(@Cast(value="size_t")
                                                              long i)

Returns the set of inputs using output i

get_input_size

@Cast(value="size_t")
public long get_input_size()

Returns the number of inputs for the op

get_input_element_type

@Const
 @ByRef
public Type get_input_element_type(@Cast(value="size_t")
                                                  long i)

Returns the element type of input i

get_input_shape

@Const
 @ByRef
public Shape get_input_shape(@Cast(value="size_t")
                                            long i)

Returns the shape of input i

get_input_partial_shape

@Const
 @ByRef
public PartialShape get_input_partial_shape(@Cast(value="size_t")
                                                           long i)

Returns the partial shape of input i

get_input_tensor_name

@StdString
public BytePointer get_input_tensor_name(@Cast(value="size_t")
                                                    long i)

Returns the tensor name for input i

get_arguments

@ByVal
public NodeVector get_arguments()

get_argument

@SharedPtr
 @ByVal
public Node get_argument(@Cast(value="size_t")
                                            long index)

copy_with_new_inputs

@SharedPtr
 @ByVal
public Node copy_with_new_inputs(@Cast(value="const ngraph::OutputVector*") @ByRef
                                                    NodeOutputVector new_args)

copy_with_new_inputs

@SharedPtr
 @ByVal
public Node copy_with_new_inputs(@Cast(value="const ngraph::OutputVector*") @ByRef
                                                    NodeOutputVector inputs,
                                                    @Const @ByRef
                                                    NodeVector control_dependencies)

get_placement

@Cast(value="ngraph::Placement")
public int get_placement()

Get device placement

set_placement

public void set_placement(@Cast(value="ngraph::Placement")
                          int placement)

Set device placement

get_placement_index

@Cast(value="size_t")
public long get_placement_index()

Get device placement

set_placement_index

public void set_placement_index(@Cast(value="size_t")
                                long placement)

Set device placement

add_provenance_tag

public void add_provenance_tag(@StdString
                               BytePointer tag)

add_provenance_tag

public void add_provenance_tag(@StdString
                               String tag)

remove_provenance_tag

public void remove_provenance_tag(@StdString
                                  BytePointer tag)

\brief Adds tag_set to this node and all intermediate nodes above base

remove_provenance_tag

public void remove_provenance_tag(@StdString
                                  String tag)

add_provenance_group_member

public void add_provenance_group_member(@Const @SharedPtr @ByRef
                                        Node node)

\brief Add node to additional nodes that receive tags

add_provenance_group_members_above

@SharedPtr
 @ByVal
public Node add_provenance_group_members_above(@Cast(value="const ngraph::OutputVector*") @ByRef
                                                                  NodeOutputVector base)

\brief Add all nodes between this node and nodes in base as additional nodes to receive provenance tags.

merge_provenance_tags_from

public void merge_provenance_tags_from(@Const @Cast(value="const ngraph::Node*") @SharedPtr @ByRef
                                       Node source)

get_users

@ByVal
public NodeVector get_users(@Cast(value="bool")
                                   boolean check_is_used)

Get all the nodes that uses the current node

get_users

@ByVal
public NodeVector get_users()

get_version

@Cast(value="size_t")
public long get_version()

Returns:

Version of this node

get_default_value

@SharedPtr
 @ByVal
public Node get_default_value()

lessThan

@Cast(value="bool")
 @Name(value="operator <")
public boolean lessThan(@Const @ByRef
                                                                       Node other)

Use instance ids for comparison instead of memory addresses to improve determinism

placement_invalid

@MemberGetter
 @Cast(value="const size_t")
public static long placement_invalid()

inputs

@ByVal
public NodeInputVector inputs()

Returns:

A vector containing a handle for each of this node's inputs, in order.

input_values

@ByVal
public NodeOutputVector input_values()

Returns:

A vector containing the values for each input

outputs

@ByVal
public NodeOutputVector outputs()

Returns:

A vector containing a handle for each of this node's outputs, in order.

input

@ByVal
public NodeInput input(@Cast(value="size_t")
                              long input_index)

Returns:

A handle to the input_indexth input of this node.

Throws:

std::out_of_range - if the node does not have at least input_index+1 inputs.

input_value

@ByVal
public NodeOutput input_value(@Cast(value="size_t")
                                     long input_index)

Returns:

A handle to the input_indexth input of this node.

Throws:

std::out_of_range - if the node does not have at least input_index+1 inputs.

output

@ByVal
public NodeOutput output(@Cast(value="size_t")
                                long output_index)

Returns:

A handle to the output_indexth output of this node.

Throws:

std::out_of_range - if the node does not have at least output_index+1 outputs.