Halide
Halide::Generator< T > Class Template Reference

#include <Generator.h>

Inherits Halide::Internal::GeneratorBase.

Public Member Functions

template<typename... Args>
void apply (const Args &... args)
 
- Public Member Functions inherited from Halide::Internal::GeneratorBase
 ~GeneratorBase () override
 
void set_generator_param_values (const GeneratorParamsMap &params)
 
int natural_vector_size (Halide::Type t) const
 Given a data type, return an estimate of the "natural" vector size for that data type when compiling for the current target. More...
 
template<typename data_t >
int natural_vector_size () const
 Given a data type, return an estimate of the "natural" vector size for that data type when compiling for the current target. More...
 
void emit_cpp_stub (const std::string &stub_file_path)
 
Module build_module (const std::string &function_name="", const LinkageType linkage_type=LinkageType::ExternalPlusMetadata)
 
Module build_gradient_module (const std::string &function_name)
 Build a module that is suitable for using for gradient descent calculation in TensorFlow or PyTorch. More...
 
template<typename... Args>
void set_inputs (const Args &... args)
 set_inputs is a variadic wrapper around set_inputs_vector, which makes usage much simpler in many cases, as it constructs the relevant entries for the vector for you, which is often a bit unintuitive at present. More...
 
Realization realize (std::vector< int32_t > sizes)
 
template<typename... Args, typename std::enable_if< NoRealizations< Args... >::value >::type * = nullptr>
Realization realize (Args &&... args)
 
void realize (Realization r)
 
Pipeline get_pipeline ()
 
template<typename T , typename std::enable_if<!std::is_arithmetic< T >::value >::type * = nullptr>
GeneratorInput< T > * add_input (const std::string &name, const Type &t, int dimensions)
 
template<typename T , typename std::enable_if< T::has_static_halide_type >::type * = nullptr>
GeneratorInput< T > * add_input (const std::string &name, int dimensions)
 
template<typename T , typename std::enable_if< std::is_arithmetic< T >::value >::type * = nullptr>
GeneratorInput< T > * add_input (const std::string &name)
 
template<typename T , typename std::enable_if<!std::is_arithmetic< T >::value >::type * = nullptr>
GeneratorOutput< T > * add_output (const std::string &name, const Type &t, int dimensions)
 
template<typename T , typename std::enable_if< T::has_static_halide_type >::type * = nullptr>
GeneratorOutput< T > * add_output (const std::string &name, int dimensions)
 
template<typename... Args>
HALIDE_NO_USER_CODE_INLINE void add_requirement (Expr condition, Args &&... args)
 
void trace_pipeline ()
 
- Public Member Functions inherited from Halide::GeneratorContext
 GeneratorContext (const Target &t, bool auto_schedule=false, const MachineParams &machine_params=MachineParams::generic())
 
virtual ~GeneratorContext ()
 
Target get_target () const
 
bool get_auto_schedule () const
 
MachineParams get_machine_params () const
 
std::shared_ptr< ExternsMapget_externs_map () const
 Generators can register ExternalCode objects onto themselves. More...
 
template<typename T >
std::unique_ptr< T > create () const
 
template<typename T , typename... Args>
std::unique_ptr< T > apply (const Args &... args) const
 

Static Public Member Functions

static std::unique_ptr< T > create (const Halide::GeneratorContext &context)
 
static std::unique_ptr< T > create (const Halide::GeneratorContext &context, const std::string &registered_name, const std::string &stub_name)
 

Protected Member Functions

 Generator ()
 
Pipeline build_pipeline () override
 
void call_configure () override
 
void call_generate () override
 
void call_schedule () override
 
- Protected Member Functions inherited from Halide::Internal::GeneratorBase
 GeneratorBase (size_t size, const void *introspection_helper)
 
void set_generator_names (const std::string &registered_name, const std::string &stub_name)
 
void init_from_context (const Halide::GeneratorContext &context) override
 
void track_parameter_values (bool include_outputs)
 
void pre_build ()
 
void post_build ()
 
void pre_configure ()
 
void post_configure ()
 
void pre_generate ()
 
void post_generate ()
 
void pre_schedule ()
 
void post_schedule ()
 
void check_exact_phase (Phase expected_phase) const
 
void check_min_phase (Phase expected_phase) const
 
void advance_phase (Phase new_phase)
 
- Protected Member Functions inherited from Halide::GeneratorContext
 GeneratorContext ()
 
std::shared_ptr< Internal::ValueTrackerget_value_tracker () const
 
 GeneratorContext (const GeneratorContext &)=delete
 
void operator= (const GeneratorContext &)=delete
 
 GeneratorContext (GeneratorContext &&)=delete
 
void operator= (GeneratorContext &&)=delete
 

Additional Inherited Members

- Public Types inherited from Halide::GeneratorContext
using ExternsMap = std::map< std::string, ExternalCode >
 
- Protected Types inherited from Halide::Internal::GeneratorBase
enum  Phase {
  Created, ConfigureCalled, InputsSet, GenerateCalled,
  ScheduleCalled
}
 
template<typename T >
using Input = GeneratorInput< T >
 
template<typename T >
using Output = GeneratorOutput< T >
 
- Protected Types inherited from Halide::NamesInterface
using Expr = Halide::Expr
 
using ExternFuncArgument = Halide::ExternFuncArgument
 
using Func = Halide::Func
 
using GeneratorContext = Halide::GeneratorContext
 
using ImageParam = Halide::ImageParam
 
using LoopLevel = Halide::LoopLevel
 
using MemoryType = Halide::MemoryType
 
using NameMangling = Halide::NameMangling
 
using Pipeline = Halide::Pipeline
 
using PrefetchBoundStrategy = Halide::PrefetchBoundStrategy
 
using RDom = Halide::RDom
 
using RVar = Halide::RVar
 
using TailStrategy = Halide::TailStrategy
 
using Target = Halide::Target
 
using Tuple = Halide::Tuple
 
using Type = Halide::Type
 
using Var = Halide::Var
 
template<typename T >
using GeneratorParam = Halide::GeneratorParam< T >
 
template<typename T = void>
using Buffer = Halide::Buffer< T >
 
template<typename T >
using Param = Halide::Param< T >
 
- Static Protected Member Functions inherited from Halide::NamesInterface
template<typename T >
static Expr cast (Expr e)
 
static Expr cast (Halide::Type t, Expr e)
 
static Type Bool (int lanes=1)
 
static Type Float (int bits, int lanes=1)
 
static Type Int (int bits, int lanes=1)
 
static Type UInt (int bits, int lanes=1)
 
- Protected Attributes inherited from Halide::Internal::GeneratorBase
enum Halide::Internal::GeneratorBase::Phase Created
 
- Protected Attributes inherited from Halide::GeneratorContext
GeneratorParam< Targettarget
 
GeneratorParam< bool > auto_schedule
 
GeneratorParam< MachineParamsmachine_params
 
std::shared_ptr< ExternsMapexterns_map
 
std::shared_ptr< Internal::ValueTrackervalue_tracker
 

Detailed Description

template<class T>
class Halide::Generator< T >

Examples
tutorial/lesson_15_generators.cpp.

Definition at line 3487 of file Generator.h.

Constructor & Destructor Documentation

◆ Generator()

template<class T >
Halide::Generator< T >::Generator ( )
inlineprotected

Definition at line 3489 of file Generator.h.

References Halide::Internal.

Member Function Documentation

◆ create() [1/2]

template<class T >
static std::unique_ptr<T> Halide::Generator< T >::create ( const Halide::GeneratorContext context)
inlinestatic

Definition at line 3495 of file Generator.h.

◆ create() [2/2]

template<class T >
static std::unique_ptr<T> Halide::Generator< T >::create ( const Halide::GeneratorContext context,
const std::string &  registered_name,
const std::string &  stub_name 
)
inlinestatic

Definition at line 3504 of file Generator.h.

References Halide::GeneratorContext::create().

◆ apply()

template<class T >
template<typename... Args>
void Halide::Generator< T >::apply ( const Args &...  args)
inline

◆ build_pipeline()

template<class T >
Pipeline Halide::Generator< T >::build_pipeline ( )
inlineoverrideprotectedvirtual

Implements Halide::Internal::GeneratorBase.

Definition at line 3658 of file Generator.h.

◆ call_configure()

template<class T >
void Halide::Generator< T >::call_configure ( )
inlineoverrideprotectedvirtual

Implements Halide::Internal::GeneratorBase.

Definition at line 3662 of file Generator.h.

Referenced by Halide::Generator< T >::apply().

◆ call_generate()

template<class T >
void Halide::Generator< T >::call_generate ( )
inlineoverrideprotectedvirtual

Implements Halide::Internal::GeneratorBase.

Definition at line 3666 of file Generator.h.

Referenced by Halide::Generator< T >::apply().

◆ call_schedule()

template<class T >
void Halide::Generator< T >::call_schedule ( )
inlineoverrideprotectedvirtual

Implements Halide::Internal::GeneratorBase.

Definition at line 3670 of file Generator.h.

Referenced by Halide::Generator< T >::apply().


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