Skip to main content

ClikaRT::nn::CosineSimilarityOptions

struct

Header: ClikaRT/nn/generated/distance.h

Settings of CosineSimilarity: chain the setters, or assign the fields.

Member functions​

CosineSimilarityOptions()​

CosineSimilarityOptions() =default

Declared in ClikaRT/nn/generated/distance.h, line 34

CosineSimilarityOptions(int64_t, optional<double>)​

explicit CosineSimilarityOptions(std::int64_t dim, std::optional<double> eps = std::nullopt)

CosineSimilarityOptions(dim, eps): the positional form.

Declared in ClikaRT/nn/generated/distance.h, line 36

dim(int64_t)​

CosineSimilarityOptions& dim(std::int64_t v)

Sets dim, the axis reduced by the dot product and the norms.

Declared in ClikaRT/nn/generated/distance.h, line 40

dim()​

std::int64_t dim() const

Reads dim.

Declared in ClikaRT/nn/generated/distance.h, line 42

eps(optional<double>)​

CosineSimilarityOptions& eps(std::optional<double> v)

Sets eps, the divide-by-zero floor; unset is 1e-8.

Declared in ClikaRT/nn/generated/distance.h, line 47

eps()​

const std::optional<double>& eps() const

Reads eps.

Declared in ClikaRT/nn/generated/distance.h, line 52

Data members​

dim_​

std::int64_t dim_ = 1

The axis reduced by the dot product and the norms. Default 1.

Declared in ClikaRT/nn/generated/distance.h, line 44

eps_​

std::optional<double> eps_ = std::nullopt

The divide-by-zero floor; unset is 1e-8. Default std::nullopt.

Declared in ClikaRT/nn/generated/distance.h, line 54