Various options for the comparison of expressions or expression lists.

See also:

The flags parameter of compare()

Clones the given expression. Note that referenced DB elements, e.g., resources in constant expressions, or function calls and material instances in call expressions, are not copied, but shared. Function calls and material instances that serve as default arguments, are copied, though.

Clones the given expression. Note that referenced DB elements, e.g., resources in constant expressions, or function calls and material instances in call expressions, are not copied, but shared. Function calls and material instances that serve as default arguments, are copied, though.

Clones the given expression list. Note that referenced DB elements, e.g., resources in constant expressions, or function calls and material instances in call expressions, are not copied, but shared.

Compares two instances of mi::neuraylib::IExpression. The comparison operator for instances of mi::neuraylib::IExpression is defined as follows:

• If lhs or rhs is NULL, the result is the lexicographic comparison of the pointer addresses themselves.

• Otherwise, the types of lhs and rhs are compared. If they are different, the result is determined by that comparison.

• Next, the kind of the expressions are compared. If they are different, the result is determined by operator< on the mi::neuraylib::IExpression::Kind values. Note that setting SKIP_TYPE_ALIASES in flags modifies this behavior.

• Finally, the expressions are compared as follows:

  • For constants the results is defined by comparing their values.

  • For calls, the result is defined by comparison of the call reference (unless DEEP_CALL_COMPARISONS is set in flags). Note that the representation of this call reference is an internal implementation detail, and the comparison result might have the opposite sign as strcmp() on the strings returned by mi::neuraylib::IExpression_call::get_call().

  • For parameter and temporary references, the results is defined by operator< () on the indices.

  • For indirect calls, first the definition reference is compared. Note that the representation of this definition reference is an internal implementation detail, and the comparison result might have the opposite sign as strcmp() on the strings returned by mi::neuraylib::IExpression_direct_call::get_definition(). If both indirect call reference the same definition, then the result is defined by comparison of the arguments.

Parameters

lhs

The left-hand side operand for the comparison.

rhs

The right-hand side operand for the comparison.

flags

A bitmask of flags of type Comparison_options.

epsilon

Maximum difference for floating point values to consider them as equal.

Returns

-1 if lhs < rhs , 0 if lhs == rhs , and +1 if lhs > rhs .

Compares two instances of mi::neuraylib::IExpression_list. The comparison operator for instances of mi::neuraylib::IExpression_list is defined as follows:

• If lhs or rhs is NULL, the result is the lexicographic comparison of the pointer addresses themselves.

• Next, the list sizes are compared using operator< () .

• Next, the lists are traversed by increasing index and the names are compared using strcmp().

• Finally, the list elements are enumerated by increasing index and the expressions are compared.

Parameters

lhs

The left-hand side operand for the comparison.

rhs

The right-hand side operand for the comparison.

flags

A bitmask of flags of type Comparison_options.

epsilon

Maximum difference for floating point values to consider them as equal.

Returns

-1 if lhs < rhs , 0 if lhs == rhs , and +1 if lhs > rhs .

Creates a new annotation. Returns NULL if one of the arguments is not a constant expression.

Creates a new annotation block.

Creates a new annotation list.

Creates a call.

Parameters

name

The DB name of the referenced function call or material instance.

Returns

The created call, or NULL in case of errors.

Returns an expression which casts the source expression to a target type. This is a convenience function that creates an instance of the cast operator with the necessary arguments, stores it in the database, and returns a call expressions for the just created function. Note that the cast operator requires that the type of the source expression and the target type are compatible (see mi::neuraylib::IType_factory::is_compatible()).

See also:

Cast operator

Parameters

src_expr

The expression whose type is supposed to be cast.

target_type

The result type of the cast. Note that the inserted cast operator acts on types without qualifiers, i.e., modifiers on target_type are ignored.

cast_db_name

This name is used when storing the instance of the cast operator in the database. If the name is already taken by another DB element, this string will be used as the base for generating a unique name. If NULL, a unique name is generated.

force_cast

This flag has only an effect if the type of the source expression is identical to the target type. If true, then the cast expression will still be created. If false, then src_expr itself will be returned.

direct_call

Indicates whether to create a direct call expression or an (indirect) call expression.

errors

An optional pointer to an mi::Sint32 to which an error code will be written. The error codes have the following meaning:

• 0: Success.
• -1: Invalid parameters (NULL pointer).
• -2: The type of src_expr cannot be cast to target_type.

Returns

The resulting expression or NULL in case of failure.

Creates a constant (mutable).

Parameters

value

The value of the constant.

Returns

The created constant, or NULL in case of errors.

Creates a constant (const).

Parameters

value

The value of the constant.

Returns

The created constant.

Returns an expression which casts the source expression to a target type. This is a convenience function that creates an instance of the decl_cast operator with the necessary arguments, stores it in the database, and returns a call expressions for the just created function. Note that the decl_cast operator requires that the type of the source expression and the target type are struct types from the same struct category (see mi::neuraylib::IType_factory::from_same_struct_category()).

See also:

Decl_cast operator

Parameters

src_expr

The expression whose type is supposed to be cast.

target_type

The result type of the cast. Note that the inserted decl_cast operator acts on types without qualifiers, i.e., modifiers on target_type are ignored.

cast_db_name

This name is used when storing the instance of the decl_cast operator in the database. If the name is already taken by another DB element, this string will be used as the base for generating a unique name. If NULL, a unique name is generated.

force_cast

This flag has only an effect if the type of the source expression is identical to the target type. If true, then the decl_cast expression will still be created. If false, then src_expr itself will be returned.

direct_call

Indicates whether to create a direct call expression or an (indirect) call expression.

errors

An optional pointer to an mi::Sint32 to which an error code will be written. The error codes have the following meaning:

• 0: Success.
• -1: Invalid parameters (NULL pointer).
• -2: The type of src_expr cannot be cast to target_type.

Returns

The resulting expression or NULL in case of failure.

Creates a direct call.

Parameters

name

The DB name of the referenced function or material definition.

arguments

The arguments of the created direct call. Arguments for parameters without default are mandatory, otherwise optional. The type of an argument must match the corresponding parameter type. Any argument missing in arguments will be set to the default of the corresponding parameter. Note that the expressions in arguments are copied. Valid subexpressions are constants, direct calls, and parameter references. operation is a deep copy, e.g., DB elements referenced in call expressions are also copied. NULL is a valid argument which is handled like an empty expression list.

errors

An optional pointer to an mi::Sint32 to which an error code will be written. The error codes have the following meaning:

• 0: Success.
• -1: An argument for a non-existing parameter was provided in arguments.
• -2: The type of an argument in arguments does not have the correct type.
• -3: A parameter that has no default was not provided with an argument value.
• -5: A parameter type is uniform, but the corresponding argument has a varying return type.
• -6: An argument expression is not a constant, a direct call, nor a parameter.
• -7: Invalid parameters (NULL pointer) or name is not a valid DB name of a function or material definition.
• -8: One of the parameter types is uniform, but the corresponding argument or default is a call expression and the return type of the called function or material definition is effectively varying since the function or material definition itself is varying.
• -9: The function or material definition is invalid due to a module reload.

Returns

The created call, or NULL in case of errors.

Creates a new expression list.

Creates a parameter reference.

Parameters

type

The type of the parameter.

index

The index of the parameter.

Returns

The created parameter reference, or NULL in case of errors.

Creates a temporary reference.

Parameters

type

The type of the temporary.

index

The index of the temporary.

Returns

The created temporary reference, or NULL in case of errors.

Returns a textual representation of an expression. The parameter depth is only relevant for constants, where the argument is passed to mi::neuraylib::IValue_factory::dump().

Returns a textual representation of an expression list. The representation of the expression list will contain line breaks. Subsequent lines have a suitable indentation. The assumed indentation level of the first line is specified by depth.

Returns a textual representation of an annotation. The representation of the annotation will contain line breaks. Subsequent lines have a suitable indentation. The assumed indentation level of the first line is specified by depth.

Returns a textual representation of an annotation block. The representation of the annotation block will contain line breaks. Subsequent lines have a suitable indentation. The assumed indentation level of the first line is specified by depth.

Returns a textual representation of an annotation list. The representation of the annotation list will contain line breaks. Subsequent lines have a suitable indentation. The assumed indentation level of the first line is specified by depth.

Returns the value factory associated with this expression factory.