Halide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Halide::Realization Class Reference

Funcs with Tuple values return multiple images when you realize them. More...

#include <Tuple.h>

Classes

struct  const_iterator
 
struct  iterator
 Support for iterating over a the Images in a Realization. More...
 

Public Member Functions

size_t size () const
 The number of images in the Realization. More...
 
Imageoperator[] (size_t x)
 Get a reference to one of the images. More...
 
const Imageoperator[] (size_t x) const
 Get one of the images. More...
 
template<typename T , int D>
 operator Image< T, D > () const
 Single-element realizations are implicitly castable to Images. More...
 
 Realization (const std::vector< Image<>> &e)
 Construct a Realization from a vector of Image<> More...
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
template<typename T , int D, typename... Args, typename = std::enable_if<Internal::all_are_convertible<Image<>, Args...>::value>>
 Realization (Image< T, D > a, Args &&...args)
 Construct a Realization from some Images. More...
 

Detailed Description

Funcs with Tuple values return multiple images when you realize them.

Tuples are to Exprs as Realizations are to Images.

Examples:
tutorial/lesson_13_tuples.cpp.

Definition at line 67 of file Tuple.h.

Constructor & Destructor Documentation

template<typename T , int D, typename... Args, typename = std::enable_if<Internal::all_are_convertible<Image<>, Args...>::value>>
Halide::Realization::Realization ( Image< T, D >  a,
Args &&...  args 
)
inline

Construct a Realization from some Images.

Definition at line 98 of file Tuple.h.

References Halide::Runtime::Internal::a.

Halide::Realization::Realization ( const std::vector< Image<>> &  e)
inlineexplicit

Construct a Realization from a vector of Image<>

Definition at line 104 of file Tuple.h.

References user_assert.

Member Function Documentation

size_t Halide::Realization::size ( ) const
inline

The number of images in the Realization.

Examples:
tutorial/lesson_13_tuples.cpp.

Definition at line 72 of file Tuple.h.

Image& Halide::Realization::operator[] ( size_t  x)
inline

Get a reference to one of the images.

Definition at line 75 of file Tuple.h.

References user_assert.

const Image& Halide::Realization::operator[] ( size_t  x) const
inline

Get one of the images.

Definition at line 81 of file Tuple.h.

References user_assert.

template<typename T , int D>
Halide::Realization::operator Image< T, D > ( ) const
inline

Single-element realizations are implicitly castable to Images.

Definition at line 88 of file Tuple.h.

iterator Halide::Realization::begin ( )
inline

Definition at line 127 of file Tuple.h.

iterator Halide::Realization::end ( )
inline

Definition at line 131 of file Tuple.h.

const_iterator Halide::Realization::begin ( ) const
inline

Definition at line 150 of file Tuple.h.

const_iterator Halide::Realization::end ( ) const
inline

Definition at line 154 of file Tuple.h.


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