ObjectiveMetricUtils Namespace Reference

Description

Utility functions related to class ObjectiveMetric.

Functions
std::string	availableMetricOptions ()
	Prints available metric options. More...
std::unique_ptr< ObjectiveMetric >	createMetric (const std::string &metric)
	Creates the specified metric with the default norm. More...
std::unique_ptr< ObjectiveMetric >	createMetric (std::string metric, std::string norm)
	Creates the metric with the specified norm. More...
std::string	defaultMetricName ()
	Returns default metric name. More...
std::string	defaultNormName ()
	Returns default norm name. More...
std::function< double(double)>	l1Norm ()
	Returns L1 normalization function. More...
std::function< double(double)>	l2Norm ()
	Returns L2 normalization function. More...
std::vector< std::string >	metricNames ()
	Returns the names of the objective metrics used. More...
std::vector< std::string >	normNames ()
	Returns the names of the norms used by ObjectiveMetric. More...

Function Documentation

availableMetricOptions()

std::string ObjectiveMetricUtils::availableMetricOptions

(

)

Prints available metric options.

Definition at line 86 of file ObjectiveMetricUtils.cpp.

{
    std::stringstream ss;
    ss << "Available metrics:\n";
    for (auto& item : metricNames())
        ss << "\t" << item << "\n";
    ss << "default metric: " << defaultMetricName() << "\n";
    ss << "Available norms:\n";
    for (auto& item : normNames())
        ss << "\t" << item << "\n";
    ss << "default norm: " << defaultNormName() << "\n";
    return ss.str();
}

References defaultMetricName(), defaultNormName(), metricNames(), and normNames().

Referenced by FitObjective::availableMetricOptions(), and createMetric().

Here is the call graph for this function:

createMetric() [1/2]

std::unique_ptr< ObjectiveMetric > ObjectiveMetricUtils::createMetric

(

const std::string &

metric

)

Creates the specified metric with the default norm.

Definition at line 61 of file ObjectiveMetricUtils.cpp.

{
    return createMetric(metric, defaultNormName());
}

References defaultNormName().

Referenced by FitObjective::setObjectiveMetric().

Here is the call graph for this function:

createMetric() [2/2]

std::unique_ptr< ObjectiveMetric > ObjectiveMetricUtils::createMetric	(	std::string	metric,
		std::string	norm
	)

Creates the metric with the specified norm.

Definition at line 66 of file ObjectiveMetricUtils.cpp.

{
    std::transform(metric.begin(), metric.end(), metric.begin(), ::tolower);
    std::transform(norm.begin(), norm.end(), norm.begin(), ::tolower);
    const auto metric_iter = metric_factory.find(metric);
    const auto norm_iter = norm_factory.find(norm);
    if (metric_iter == metric_factory.end() || norm_iter == norm_factory.end()) {
        std::stringstream ss;
        ss << "Error in ObjectiveMetricUtils::createMetric: either metric (" << metric
           << ") or norm (" << norm << ") name is unknown.\n";
        ss << availableMetricOptions();
        throw std::runtime_error(ss.str());
    }
 
    auto result = metric_iter->second();
    result->setNorm(norm_iter->second);
    return result;
}

References availableMetricOptions().

Here is the call graph for this function:

defaultMetricName()

std::string ObjectiveMetricUtils::defaultMetricName

(

)

Returns default metric name.

Definition at line 115 of file ObjectiveMetricUtils.cpp.

{
    return default_metric_name;
}

Referenced by availableMetricOptions().

defaultNormName()

std::string ObjectiveMetricUtils::defaultNormName

(

)

Returns default norm name.

Definition at line 110 of file ObjectiveMetricUtils.cpp.

{
    return default_norm_name;
}

Referenced by availableMetricOptions(), createMetric(), and FitObjective::setObjectiveMetric().

l1Norm()

std::function< double(double)> ObjectiveMetricUtils::l1Norm

(

)

Returns L1 normalization function.

Definition at line 51 of file ObjectiveMetricUtils.cpp.

{
    return l1_norm;
}

l2Norm()

std::function< double(double)> ObjectiveMetricUtils::l2Norm

(

)

Returns L2 normalization function.

Definition at line 56 of file ObjectiveMetricUtils.cpp.

{
    return l2_norm;
}

metricNames()

std::vector< std::string > ObjectiveMetricUtils::metricNames

(

)

Returns the names of the objective metrics used.

Definition at line 105 of file ObjectiveMetricUtils.cpp.

{
    return keys(metric_factory);
}

Referenced by availableMetricOptions().

normNames()

std::vector< std::string > ObjectiveMetricUtils::normNames

(

)

Returns the names of the norms used by ObjectiveMetric.

Definition at line 100 of file ObjectiveMetricUtils.cpp.

{
    return keys(norm_factory);
}

Referenced by availableMetricOptions().