Public Member Functions | Protected Member Functions | Protected Attributes | Friends
ngraph::descriptor::Input Class Reference
Collaboration diagram for ngraph::descriptor::Input:
Collaboration graph
[legend]

Public Member Functions

 Input (Node *node, size_t index, Output &output)
 
 Input (Node *node, size_t index)
 Create an Input that is not connected to an output. More...
 
std::shared_ptr< Node > get_node () const
 
Node * get_raw_pointer_node () const
 
size_t get_index () const
 
const Outputget_output () const
 
Outputget_output ()
 
bool has_output () const
 
const Tensorget_tensor () const
 
Tensorget_tensor ()
 
void replace_output (std::shared_ptr< Node > node, size_t i)
 Replace the current output that supplies a value for this input with output i of node.
 
void replace_output (Output &output)
 Replace the current output that supplies a value for this input with output.
 
void remove_output ()
 Remove the output from this input. The node will not be valid until another output is supplied.
 
bool get_is_relevant_to_shape () const
 
bool get_is_relevant_to_value () const
 
const Shape & get_shape () const
 
const PartialShape & get_partial_shape () const
 
const element::Typeget_element_type () const
 
 Input (const Input &)=default
 
 Input (Input &&)=default
 
Inputoperator= (const Input &)=default
 

Protected Member Functions

std::shared_ptr< const Tensorget_tensor_ptr () const
 
std::shared_ptr< Tensorget_tensor_ptr ()
 

Protected Attributes

std::shared_ptr< Node > m_src_node
 
Node * m_node
 
size_t m_index
 
Outputm_output
 

Friends

class ngraph::Node
 

Constructor & Destructor Documentation

◆ Input() [1/2]

ngraph::descriptor::Input::Input ( Node *  node,
size_t  index,
Output output 
)
Parameters
nodeThe node that owns this input
indexThe position of this this tensor in all input tensors
outputThe output that supplies a value for this input

◆ Input() [2/2]

ngraph::descriptor::Input::Input ( Node *  node,
size_t  index 
)

Create an Input that is not connected to an output.

Parameters
nodeThe node that owns this input
indexThe position of this this tensor in all input tensors

Member Function Documentation

◆ get_element_type()

const element::Type& ngraph::descriptor::Input::get_element_type ( ) const
Returns
the element type of the connected output

◆ get_index()

size_t ngraph::descriptor::Input::get_index ( ) const
inline
Returns
the position within all supplied tensors of this input

◆ get_is_relevant_to_shape()

bool ngraph::descriptor::Input::get_is_relevant_to_shape ( ) const
inline
Returns
true if the value of this input is relevant to the output shapes of the corresponding node. (Usually this is false.)

See Node::set_input_is_relevant_to_shape for more details.

◆ get_is_relevant_to_value()

bool ngraph::descriptor::Input::get_is_relevant_to_value ( ) const
inline
Returns
true if the value of this input is relevant to the output value of the corresponding node. (Usually this is true.)

See Node::set_input_is_relevant_to_value for more details.

◆ get_node()

std::shared_ptr<Node> ngraph::descriptor::Input::get_node ( ) const
Returns
the node that this is an input of

◆ get_output() [1/2]

Output& ngraph::descriptor::Input::get_output ( )
inline
Returns
the connected output

◆ get_output() [2/2]

const Output& ngraph::descriptor::Input::get_output ( ) const
inline
Returns
the connected output

◆ get_partial_shape()

const PartialShape& ngraph::descriptor::Input::get_partial_shape ( ) const
Returns
the partial shape of the connected output

◆ get_raw_pointer_node()

Node* ngraph::descriptor::Input::get_raw_pointer_node ( ) const
inline
Returns
the raw pointer to the node that this is an input of

◆ get_shape()

const Shape& ngraph::descriptor::Input::get_shape ( ) const
Returns
the shape of the connected output

◆ get_tensor() [1/2]

Tensor& ngraph::descriptor::Input::get_tensor ( )
Returns
the tensor of the connected output

◆ get_tensor() [2/2]

const Tensor& ngraph::descriptor::Input::get_tensor ( ) const
Returns
the tensor of the connected output

◆ get_tensor_ptr() [1/2]

std::shared_ptr<Tensor> ngraph::descriptor::Input::get_tensor_ptr ( )
protected
Returns
the tensor for the connected output

◆ get_tensor_ptr() [2/2]

std::shared_ptr<const Tensor> ngraph::descriptor::Input::get_tensor_ptr ( ) const
protected
Returns
the tensor for the connected output

◆ has_output()

bool ngraph::descriptor::Input::has_output ( ) const
inline
Returns
true if an output is connected to the input.

The documentation for this class was generated from the following file: