class ov::op::v8::If

Overview

If operation. More…

#include <if.hpp>

class If: public ov::op::util::MultiSubGraphOp
{
public:
    // enums

    enum BodyIndexes;

    // construction

    If(const Output<Node>& execution_condition);
    If();

    // methods

    OPENVINO_OP("If", "opset8", util::MultiSubGraphOp);
    virtual bool visit_attributes(AttributeVisitor& visitor);
    virtual std::shared_ptr<Node> clone_with_new_inputs(const OutputVector& new_args) const;
    const std::shared_ptr<Model>& get_then_body() const;
    const std::shared_ptr<Model>& get_else_body() const;
    void set_then_body(const std::shared_ptr<Model>& body);
    void set_else_body(const std::shared_ptr<Model>& body);

    void set_input(
        const Output<Node>& value,
        const std::shared_ptr<v0::Parameter>& then_parameter,
        const std::shared_ptr<v0::Parameter>& else_parameter
        );

    Output<Node> set_output(
        const std::shared_ptr<v0::Result>& then_result,
        const std::shared_ptr<v0::Result>& else_result
        );

    virtual void validate_and_infer_types();
};

Inherited Members

public:
    // typedefs

    typedef DiscreteTypeInfo type_info_t;
    typedef std::map<std::string, Any> RTMap;
    typedef std::vector<MultiSubGraphOp::InputDescription::Ptr> MultiSubgraphInputDescriptionVector;
    typedef std::vector<MultiSubGraphOp::OutputDescription::Ptr> MultiSubgraphOutputDescriptionVector;

    // classes

    class BodyOutputDescription;
    class ConcatOutputDescription;
    class InputDescription;
    class InvariantInputDescription;
    class MergedInputDescription;
    class OutputDescription;
    class SliceInputDescription;

    // methods

    virtual void validate_and_infer_types();
    void constructor_validate_and_infer_types();
    virtual bool visit_attributes(AttributeVisitor&);
    virtual const ov::op::AutoBroadcastSpec& get_autob() const;
    virtual bool has_evaluate() const;

    virtual bool evaluate(
        const ov::HostTensorVector& output_values,
        const ov::HostTensorVector& input_values
        ) const;

    virtual bool evaluate(
        const ov::HostTensorVector& output_values,
        const ov::HostTensorVector& input_values,
        const EvaluationContext& evaluationContext
        ) const;

    virtual bool evaluate_lower(const ov::HostTensorVector& output_values) const;
    virtual bool evaluate_upper(const ov::HostTensorVector& output_values) const;

    virtual bool evaluate(
        ov::TensorVector& output_values,
        const ov::TensorVector& input_values
        ) const;

    virtual bool evaluate(
        ov::TensorVector& output_values,
        const ov::TensorVector& input_values,
        const ov::EvaluationContext& evaluationContext
        ) const;

    virtual bool evaluate_lower(ov::TensorVector& output_values) const;
    virtual bool evaluate_upper(ov::TensorVector& output_values) const;
    virtual bool evaluate_label(TensorLabelVector& output_labels) const;

    virtual bool constant_fold(
        OutputVector& output_values,
        const OutputVector& inputs_values
        );

    virtual OutputVector decompose_op() const;
    virtual const type_info_t& get_type_info() const = 0;
    const char \* get_type_name() const;
    void set_arguments(const NodeVector& arguments);
    void set_arguments(const OutputVector& arguments);
    void set_argument(size_t position, const Output<Node>& argument);

    void set_output_type(
        size_t i,
        const element::Type& element_type,
        const PartialShape& pshape
        );

    void set_output_size(size_t output_size);
    void invalidate_values();
    virtual void revalidate_and_infer_types();
    virtual std::string description() const;
    const std::string& get_name() const;
    void set_friendly_name(const std::string& name);
    const std::string& get_friendly_name() const;
    virtual bool is_dynamic() const;
    size_t get_instance_id() const;
    virtual std::ostream& write_description(std::ostream& os, uint32_t depth = 0) const;
    const std::vector<std::shared_ptr<Node>>& get_control_dependencies() const;
    const std::vector<Node \*>& get_control_dependents() const;
    void add_control_dependency(std::shared_ptr<Node> node);
    void remove_control_dependency(std::shared_ptr<Node> node);
    void clear_control_dependencies();
    void clear_control_dependents();
    void add_node_control_dependencies(std::shared_ptr<Node> source_node);
    void add_node_control_dependents(std::shared_ptr<Node> source_node);
    void transfer_control_dependents(std::shared_ptr<Node> replacement);
    size_t get_output_size() const;
    const element::Type& get_output_element_type(size_t i) const;
    const element::Type& get_element_type() const;
    const Shape& get_output_shape(size_t i) const;
    const PartialShape& get_output_partial_shape(size_t i) const;
    Output<const Node> get_default_output() const;
    Output<Node> get_default_output();
    virtual size_t get_default_output_index() const;
    size_t no_default_index() const;
    const Shape& get_shape() const;
    descriptor::Tensor& get_output_tensor(size_t i) const;
    descriptor::Tensor& get_input_tensor(size_t i) const;
    std::set<Input<Node>> get_output_target_inputs(size_t i) const;
    size_t get_input_size() const;
    const element::Type& get_input_element_type(size_t i) const;
    const Shape& get_input_shape(size_t i) const;
    const PartialShape& get_input_partial_shape(size_t i) const;
    Node \* get_input_node_ptr(size_t index) const;
    std::shared_ptr<Node> get_input_node_shared_ptr(size_t index) const;
    Output<Node> get_input_source_output(size_t i) const;
    virtual std::shared_ptr<Node> clone_with_new_inputs(const OutputVector& inputs) const = 0;
    std::shared_ptr<Node> copy_with_new_inputs(const OutputVector& new_args) const;

    std::shared_ptr<Node> copy_with_new_inputs(
        const OutputVector& inputs,
        const std::vector<std::shared_ptr<Node>>& control_dependencies
        ) const;

    bool has_same_type(std::shared_ptr<const Node> node) const;
    RTMap& get_rt_info();
    const RTMap& get_rt_info() const;
    NodeVector get_users(bool check_is_used = false) const;
    virtual size_t get_version() const;
    virtual std::shared_ptr<Node> get_default_value() const;
    bool operator < (const Node& other) const;
    std::vector<Input<Node>> inputs();
    std::vector<Input<const Node>> inputs() const;
    std::vector<Output<Node>> input_values() const;
    std::vector<Output<Node>> outputs();
    std::vector<Output<const Node>> outputs() const;
    Input<Node> input(size_t input_index);
    Input<const Node> input(size_t input_index) const;
    Output<Node> input_value(size_t input_index) const;
    Output<Node> output(size_t output_index);
    Output<const Node> output(size_t output_index) const;
    OPENVINO_SUPPRESS_DEPRECATED_START void set_op_annotations(std::shared_ptr<ngraph::op::util::OpAnnotations> op_annotations);
    std::shared_ptr<ngraph::op::util::OpAnnotations> get_op_annotations() const;

    virtual OPENVINO_SUPPRESS_DEPRECATED_END bool match_value(
        ov::pass::pattern::Matcher \* matcher,
        const Output<Node>& pattern_value,
        const Output<Node>& graph_value
        );

    virtual bool match_node(
        ov::pass::pattern::Matcher \* matcher,
        const Output<Node>& graph_value
        );

    static _OPENVINO_HIDDEN_METHODconst ::ov::Node::type_info_t& get_type_info_static();
    virtual const ::ov::Node::type_info_t& get_type_info() const;
    OPENVINO_OP("MultiSubGraphOp", "util");
    virtual const std::shared_ptr<Model>& get_function(int index) const;
    virtual void set_function(int index, const std::shared_ptr<Model>& func);
    const MultiSubgraphInputDescriptionVector& get_input_descriptions(int index) const;
    MultiSubgraphInputDescriptionVector& get_input_descriptions(int index);
    const MultiSubgraphOutputDescriptionVector& get_output_descriptions(int index) const;
    MultiSubgraphOutputDescriptionVector& get_output_descriptions(int index);

    void set_input_descriptions(
        int index,
        const MultiSubgraphInputDescriptionVector& inputs
        );

    void set_output_descriptions(
        int index,
        const MultiSubgraphOutputDescriptionVector& outputs
        );

    virtual void set_invariant_inputs(
        const Output<Node>& value,
        const ov::ParameterVector& bodies_parameters
        );

    virtual Output<Node> set_body_outputs(const ResultVector& bodies_results);
    virtual size_t get_internal_subgraphs_size() const;
    virtual size_t get_input_descriptions_size() const;
    virtual size_t get_output_descriptions_size() const;
    bool get_transformations_allowed() const;
    MultiSubGraphOp& operator = (const MultiSubGraphOp&);
    MultiSubGraphOp& operator = (MultiSubGraphOp&&);

Detailed Documentation

If operation.

Construction

If(const Output<Node>& execution_condition)

Constructs If with condition.

Parameters:

execution_condition

condition node.

Methods

const std::shared_ptr<Model>& get_then_body() const

gets then_body as ov::Model.

Returns:

then_body as ov::Model.

const std::shared_ptr<Model>& get_else_body() const

gets else_body as ov::Model.

Returns:

else_body as ov::Model.

void set_then_body(const std::shared_ptr<Model>& body)

sets new ov::Model as new then_body.

Parameters:

body

new body for ‘then’ branch.

void set_else_body(const std::shared_ptr<Model>& body)

sets new ov::Model as new else_body.

Parameters:

body

new body for ‘else’ branch.

void set_input(
    const Output<Node>& value,
    const std::shared_ptr<v0::Parameter>& then_parameter,
    const std::shared_ptr<v0::Parameter>& else_parameter
    )

sets new input to the operation associated with parameters of each sub-graphs

Parameters:

value

input to operation

then_parameter

parameter for then_body or nullptr

else_parameter

parameter for else_body or nullpt

Output<Node> set_output(
    const std::shared_ptr<v0::Result>& then_result,
    const std::shared_ptr<v0::Result>& else_result
    )

sets new output from the operation associated with results of each sub-graphs

Parameters:

then_result

result from then_body

else_parameter

result from else_body

Returns:

output from operation

virtual void validate_and_infer_types()

Verifies that attributes and inputs are consistent and computes output shapes and element types. Must be implemented by concrete child classes so that it can be run any number of times.

Throws if the node is invalid.