Halide
Halide::Module Class Reference

A halide module. More...

#include <Module.h>

Public Member Functions

 Module (const std::string &name, const Target &target)
 
const Targettarget () const
 Get the target this module has been lowered for. More...
 
const std::string & name () const
 The name of this module. More...
 
const AutoSchedulerResultsget_auto_scheduler_results () const
 If this Module had an auto-generated schedule, return a read-only pointer to the AutoSchedulerResults. More...
 
bool any_strict_float () const
 Return whether this module uses strict floating-point anywhere. More...
 
const std::vector< Buffer< void > > & buffers () const
 The declarations contained in this module. More...
 
const std::vector< Internal::LoweredFunc > & functions () const
 
std::vector< Internal::LoweredFunc > & functions ()
 
const std::vector< Module > & submodules () const
 
const std::vector< ExternalCode > & external_code () const
 
Internal::LoweredFunc get_function_by_name (const std::string &name) const
 Return the function with the given name. More...
 
void append (const Buffer< void > &buffer)
 Add a declaration to this module. More...
 
void append (const Internal::LoweredFunc &function)
 
void append (const Module &module)
 
void append (const ExternalCode &external_code)
 
void compile (const std::map< Output, std::string > &output_files) const
 Compile a halide Module to variety of outputs, depending on the fields set in output_files. More...
 
Buffer< uint8_tcompile_to_buffer () const
 Compile a halide Module to in-memory object code. More...
 
Module resolve_submodules () const
 Return a new module with all submodules compiled to buffers on on the result Module. More...
 
void remap_metadata_name (const std::string &from, const std::string &to) const
 When generating metadata from this module, remap any occurrences of 'from' into 'to'. More...
 
std::map< std::string, std::string > get_metadata_name_map () const
 Retrieve the metadata name map. More...
 
void set_auto_scheduler_results (const AutoSchedulerResults &results)
 Set the AutoSchedulerResults for the Module. More...
 
void set_any_strict_float (bool any_strict_float)
 Set whether this module uses strict floating-point directives anywhere. More...
 

Detailed Description

A halide module.

This represents IR containing lowered function definitions and buffers.

Definition at line 136 of file Module.h.

Constructor & Destructor Documentation

◆ Module()

Halide::Module::Module ( const std::string &  name,
const Target target 
)

Member Function Documentation

◆ target()

const Target& Halide::Module::target ( ) const

Get the target this module has been lowered for.

◆ name()

const std::string& Halide::Module::name ( ) const

The name of this module.

This is used as the default filename for output operations.

◆ get_auto_scheduler_results()

const AutoSchedulerResults* Halide::Module::get_auto_scheduler_results ( ) const

If this Module had an auto-generated schedule, return a read-only pointer to the AutoSchedulerResults.

If not, return nullptr.

◆ any_strict_float()

bool Halide::Module::any_strict_float ( ) const

Return whether this module uses strict floating-point anywhere.

◆ buffers()

const std::vector<Buffer<void> >& Halide::Module::buffers ( ) const

The declarations contained in this module.

◆ functions() [1/2]

const std::vector<Internal::LoweredFunc>& Halide::Module::functions ( ) const

◆ functions() [2/2]

std::vector<Internal::LoweredFunc>& Halide::Module::functions ( )

◆ submodules()

const std::vector<Module>& Halide::Module::submodules ( ) const

◆ external_code()

const std::vector<ExternalCode>& Halide::Module::external_code ( ) const

◆ get_function_by_name()

Internal::LoweredFunc Halide::Module::get_function_by_name ( const std::string &  name) const

Return the function with the given name.

If no such function exists in this module, assert.

◆ append() [1/4]

void Halide::Module::append ( const Buffer< void > &  buffer)

Add a declaration to this module.

◆ append() [2/4]

void Halide::Module::append ( const Internal::LoweredFunc function)

◆ append() [3/4]

void Halide::Module::append ( const Module module)

◆ append() [4/4]

void Halide::Module::append ( const ExternalCode external_code)

◆ compile()

void Halide::Module::compile ( const std::map< Output, std::string > &  output_files) const

Compile a halide Module to variety of outputs, depending on the fields set in output_files.

◆ compile_to_buffer()

Buffer<uint8_t> Halide::Module::compile_to_buffer ( ) const

Compile a halide Module to in-memory object code.

Currently only supports LLVM based compilation, but should be extended to handle source code backends.

◆ resolve_submodules()

Module Halide::Module::resolve_submodules ( ) const

Return a new module with all submodules compiled to buffers on on the result Module.

◆ remap_metadata_name()

void Halide::Module::remap_metadata_name ( const std::string &  from,
const std::string &  to 
) const

When generating metadata from this module, remap any occurrences of 'from' into 'to'.

◆ get_metadata_name_map()

std::map<std::string, std::string> Halide::Module::get_metadata_name_map ( ) const

Retrieve the metadata name map.

◆ set_auto_scheduler_results()

void Halide::Module::set_auto_scheduler_results ( const AutoSchedulerResults results)

Set the AutoSchedulerResults for the Module.

It is an error to call this multiple times for a given Module.

◆ set_any_strict_float()

void Halide::Module::set_any_strict_float ( bool  any_strict_float)

Set whether this module uses strict floating-point directives anywhere.


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