struct xilinx_apps::cosinesim::Options

Overview

Struct containing CosineSim configuration options. More…

#include <cosinesim.hpp>

struct Options
{
    // fields

    ColIndex vecLength;
    std::int32_t numDevices;
    char* xclbinPath = nullptr;

    // construction

    Options();
    Options(const Options& opt);

    // methods

    Options& operator = (const Options& opt);
    void setXclbinPath(const char* newXclbinPath);
    void setXclbinPath(const std::string& xclbinPath);
};

Detailed Documentation

Struct containing CosineSim configuration options.

Fields

ColIndex vecLength

vector length of all population and target vectors. Default is 200.

std::int32_t numDevices

number of Alveo accelerator cards to use. Default is 1.

char* xclbinPath = nullptr

FPGA binary file (XCLBIN) path. Default is the package installation path.

When setting this field, the field takes ownership of the buffer pointed to. To avoid dealing with allocation, use the setXclbinPath() function instead.

Construction

Options()

Constructs an Options object with default values.

Options(const Options& opt)

Copy constructor, which deep-copies the reference Options object.

Parameters:

opt	the Options object to copy from

Methods

Options& operator = (const Options& opt)

Deep-copies the reference Options object into this Options object.

Parameters:

opt	the Options object to copy from

Returns:

this Options object

void setXclbinPath(const char* newXclbinPath)

Sets the xclbinPath field to the given string, which is deep-copied.

Parameters:

newXclbinPath

the XCLBIN path string to set xclbinPath to

void setXclbinPath(const std::string& xclbinPath)

Sets the xclbinPath field to the given string, which is deep-copied.

Parameters:

newXclbinPath

the XCLBIN path string to set xclbinPath to