program();

explicit program(cl_program program, bool retain = true);

Creates a program object for program. If retain is true, the reference count for program will be incremented.

program(const program & other);

program(program && other) noexcept;

program & operator=(const program & other);

program & operator=(program && other) noexcept;

~program();

cl_program & get() const;

std::string source() const;

std::vector< unsigned char > binary() const;

std::vector< device > get_devices() const;

context get_context() const;

template<typename T> T get_info(cl_program_info info) const;

Returns information about the program.

See the documentation for clGetProgramInfo() for more information.

template<int Enum> unspecified get_info() const;

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T> 
  T get_build_info(cl_program_build_info info, const device & device) const;

Returns build information about the program.

For example, this function can be used to retreive the options used to build the program:

std::string build_options =
    program.get_build_info<std::string>(CL_PROGRAM_BUILD_OPTIONS);

See the documentation for clGetProgramInfo() for more information.

void build(const std::string & options = std::string());

Builds the program with options.

If the program fails to compile, this function will throw an opencl_error exception.

try {
    // attempt to compile to program
    program.build();
}
catch(boost::compute::opencl_error &e){
    // program failed to compile, print out the build log
    std::cout << program.build_log() << std::endl;
}

See the documentation for clBuildProgram() for more information.

void compile(const std::string & options = std::string());

Compiles the program with options.

	Warning
	This method is only available if the OpenCL version is 1.2 or later.

See the documentation for clCompileProgram() for more information.

std::string build_log() const;

kernel create_kernel(const std::string & name) const;

Creates and returns a new kernel object for name.

For example, to create the "foo" kernel (after the program has been created and built):

boost::compute::kernel foo_kernel = foo_program.create_kernel("foo");

bool operator==(const program & other) const;

bool operator!=(const program & other) const;

static program 
link(const std::vector< program > & programs, const context & context, 
     const std::string & options = std::string());

Links the programs in programs with options in context.

	Warning
	This method is only available if the OpenCL version is 1.2 or later.

See the documentation for clLinkProgram() for more information.

static program 
create_with_source(const std::string & source, const context & context);

Creates a new program with source in context.

See the documentation for clCreateProgramWithSource() for more information.

static program 
create_with_source_file(const std::string & file, const context & context);

Creates a new program with file in context.

See the documentation for clCreateProgramWithSource() for more information.

static program 
create_with_binary(const unsigned char * binary, size_t binary_size, 
                   const context & context);

Creates a new program with binary of binary_size in context.

See the documentation for clCreateProgramWithBinary() for more information.

static program 
create_with_binary(const std::vector< unsigned char > & binary, 
                   const context & context);

Creates a new program with binary in context.

See the documentation for clCreateProgramWithBinary() for more information.

static program 
create_with_binary_file(const std::string & file, const context & context);

Creates a new program with file in context.

See the documentation for clCreateProgramWithBinary() for more information.

static program 
create_with_builtin_kernels(const context & context, 
                            const std::vector< device > & devices, 
                            const std::string & kernel_names);

Creates a new program with the built-in kernels listed in kernel_names for devices in context.

	Warning
	This method is only available if the OpenCL version is 1.2 or later.

See the documentation for clCreateProgramWithBuiltInKernels() for more information.

static program 
build_with_source(const std::string & source, const context & context, 
                  const std::string & options = std::string());

In case BOOST_COMPUTE_USE_OFFLINE_CACHE macro is defined, the compiled binary is stored for reuse in the offline cache located in $HOME/.boost_compute on UNIX-like systems and in APPDATA%/boost_compute on Windows.