blender::fn::multi_function Namespace Reference

Namespaces
namespace	build
namespace	procedure_optimization
namespace	tests

Classes
class	MultiFunction
class	CustomMF_GenericConstant
class	CustomMF_GenericConstantArray
class	CustomMF_Constant
class	CustomMF_DefaultOutput
class	CustomMF_GenericCopy
class	Context
class	ContextBuilder
class	DataType
struct	ParamTag
class	ParamType
class	ParamsBuilder
class	Params
class	InstructionCursor
class	Variable
class	Instruction
class	CallInstruction
class	BranchInstruction
class	DestructInstruction
class	DummyInstruction
class	ReturnInstruction
struct	Parameter
struct	ConstParameter
class	Procedure
class	ProcedureBuilder
class	ProcedureExecutor
struct	Signature
class	SignatureBuilder
class	ProcedureDotExport
struct	VariableValue
struct	VariableValue_GVArray
struct	VariableValue_Span
struct	VariableValue_GVVectorArray
struct	VariableValue_GVectorArray
struct	VariableValue_OneSingle
struct	VariableValue_OneVector
class	ValueAllocator
class	VariableState
class	VariableStates
struct	InstructionIndices
struct	NextInstructionInfo
class	InstructionScheduler

Typedefs
using	ExecutionHints = MultiFunction::ExecutionHints
using	IndicesSplitVectors = std::array<Vector<int64_t>, 2>

Enumerations
enum class	ParamCategory {   SingleInput , VectorInput , SingleOutput , VectorOutput ,   SingleMutable , VectorMutable }
enum class	InstructionType {   Call , Branch , Destruct , Dummy ,   Return }
enum class	ParamFlag { None = 0 , SupportsUnusedOutput = 1 << 0 }

Functions
	ENUM_OPERATORS (ParamFlag, ParamFlag::SupportsUnusedOutput)
static bool	supports_threading_by_slicing_params (const MultiFunction &fn)
static int64_t	compute_grain_size (const ExecutionHints &hints, const IndexMask &mask)
static int64_t	compute_alignment (const int64_t grain_size)
static void	add_sliced_parameters (const Signature &signature, Params &full_params, const IndexRange slice_range, ParamsBuilder &r_sliced_params)
static bool	evaluate_as_one (Span< VariableState * > param_variable_states, const IndexMask &mask, const IndexMask &full_mask)
static void	gather_parameter_variable_states (const MultiFunction &fn, const CallInstruction &instruction, VariableStates &variable_states, MutableSpan< VariableState * > r_param_variable_states)
static void	fill_params__one (const MultiFunction &fn, const IndexMask &mask, ParamsBuilder &params, VariableStates &variable_states, const Span< VariableState * > param_variable_states)
static void	fill_params (const MultiFunction &fn, const IndexMask &mask, ParamsBuilder &params, VariableStates &variable_states, const Span< VariableState * > param_variable_states)
static void	execute_call_instruction (const CallInstruction &instruction, const IndexMask &mask, VariableStates &variable_states, const Context &context)

Typedef Documentation

ExecutionHints

using blender::fn::multi_function::ExecutionHints = MultiFunction::ExecutionHints

Definition at line 12 of file multi_function.cc.

IndicesSplitVectors

using blender::fn::multi_function::IndicesSplitVectors = std::array<Vector<int64_t>, 2>

Definition at line 22 of file multi_function_procedure_executor.cc.

Enumeration Type Documentation

InstructionType

enum class blender::fn::multi_function::InstructionType

strong

Every instruction has exactly one of these types.

Enumerator
Call
Branch
Destruct
Dummy
Return

Definition at line 25 of file FN_multi_function_procedure.hh.

ParamCategory

enum class blender::fn::multi_function::ParamCategory

strong

Enumerator
SingleInput
VectorInput
SingleOutput
VectorOutput
SingleMutable
VectorMutable

Definition at line 27 of file FN_multi_function_param_type.hh.

ParamFlag

enum class blender::fn::multi_function::ParamFlag

strong

Enumerator
None
SupportsUnusedOutput	If set, the multi-function parameter can be accessed using #Params::uninitialized_single_output_if_required which can result in better performance because the output does not have to be computed when it is not needed.

Definition at line 20 of file FN_multi_function_signature.hh.

Function Documentation

add_sliced_parameters()

void blender::fn::multi_function::add_sliced_parameters ( const Signature & signature, Params & full_params, const IndexRange slice_range, ParamsBuilder & r_sliced_params )

static

Definition at line 68 of file multi_function.cc.

References blender::fn::multi_function::ParamsBuilder::add_ignored_single_output(), blender::fn::multi_function::ParamsBuilder::add_readonly_single_input(), blender::fn::multi_function::ParamsBuilder::add_single_mutable(), blender::fn::multi_function::ParamsBuilder::add_uninitialized_single_output(), BLI_assert_unreachable, blender::fn::multi_function::ParamType::category(), blender::GMutableSpan::is_empty(), blender::fn::multi_function::Signature::params, blender::fn::multi_function::Params::readonly_single_input(), blender::fn::multi_function::Params::single_mutable(), SingleInput, SingleMutable, SingleOutput, blender::GMutableSpan::slice(), blender::GVArray::slice(), SupportsUnusedOutput, blender::fn::multi_function::Params::uninitialized_single_output(), blender::fn::multi_function::Params::uninitialized_single_output_if_required(), VectorInput, VectorMutable, and VectorOutput.

Referenced by blender::fn::multi_function::MultiFunction::call_auto().

compute_alignment()

int64_t blender::fn::multi_function::compute_alignment ( const int64_t grain_size )

static

Definition at line 58 of file multi_function.cc.

Referenced by blender::fn::multi_function::MultiFunction::call_auto().

compute_grain_size()

int64_t blender::fn::multi_function::compute_grain_size ( const ExecutionHints & hints, const IndexMask & mask )

static

Definition at line 40 of file multi_function.cc.

References blender::fn::multi_function::MultiFunction::ExecutionHints::allocates_array, BLI_system_thread_count(), mask(), blender::fn::multi_function::MultiFunction::ExecutionHints::min_grain_size, and blender::fn::multi_function::MultiFunction::ExecutionHints::uniform_execution_time.

Referenced by blender::fn::multi_function::MultiFunction::call_auto().

ENUM_OPERATORS()

blender::fn::multi_function::ENUM_OPERATORS	(	ParamFlag	,
		ParamFlag::SupportsUnusedOutput	)

References SupportsUnusedOutput.

evaluate_as_one()

bool blender::fn::multi_function::evaluate_as_one ( Span< VariableState * > param_variable_states, const IndexMask & mask, const IndexMask & full_mask )

static

Definition at line 969 of file multi_function_procedure_executor.cc.

References mask(), blender::index_mask::IndexMask::size(), and state.

Referenced by execute_call_instruction().

execute_call_instruction()

void blender::fn::multi_function::execute_call_instruction ( const CallInstruction & instruction, const IndexMask & mask, VariableStates & variable_states, const Context & context )

static

Definition at line 1037 of file multi_function_procedure_executor.cc.

References BLI_assert_unreachable, evaluate_as_one(), fill_params(), fill_params__one(), blender::fn::multi_function::CallInstruction::fn(), blender::fn::multi_function::VariableStates::full_mask(), gather_parameter_variable_states(), mask(), params, and blender::Vector< T, InlineBufferCapacity, Allocator >::resize().

Referenced by blender::fn::multi_function::ProcedureExecutor::call().

fill_params()

void blender::fn::multi_function::fill_params ( const MultiFunction & fn, const IndexMask & mask, ParamsBuilder & params, VariableStates & variable_states, const Span< VariableState * > param_variable_states )

static

Definition at line 1019 of file multi_function_procedure_executor.cc.

References blender::fn::multi_function::VariableStates::add_as_param(), mask(), and params.

Referenced by execute_call_instruction().

fill_params__one()

void blender::fn::multi_function::fill_params__one ( const MultiFunction & fn, const IndexMask & mask, ParamsBuilder & params, VariableStates & variable_states, const Span< VariableState * > param_variable_states )

static

Definition at line 1001 of file multi_function_procedure_executor.cc.

References blender::fn::multi_function::VariableStates::add_as_param__one(), mask(), and params.

Referenced by execute_call_instruction().

gather_parameter_variable_states()

void blender::fn::multi_function::gather_parameter_variable_states ( const MultiFunction & fn, const CallInstruction & instruction, VariableStates & variable_states, MutableSpan< VariableState * > r_param_variable_states )

static

Definition at line 984 of file multi_function_procedure_executor.cc.

References blender::fn::multi_function::VariableStates::get_variable_state(), and blender::fn::multi_function::CallInstruction::params().

Referenced by execute_call_instruction().

supports_threading_by_slicing_params()

bool blender::fn::multi_function::supports_threading_by_slicing_params ( const MultiFunction & fn )

static

Definition at line 24 of file multi_function.cc.

References blender::fn::multi_function::ParamType::data_type(), ELEM, i, blender::fn::multi_function::ParamType::interface_type(), blender::fn::multi_function::DataType::is_vector(), blender::fn::multi_function::ParamType::Mutable, and blender::fn::multi_function::ParamType::Output.

Referenced by blender::fn::multi_function::MultiFunction::call_auto().