get_magnitude_values: Magnitudes of an argument

View source: R/def_ParameterDefinitions.R

get_magnitude_valuesR Documentation

Magnitudes of an argument

Description

Function calculates different magnitude for a numeric argument.

Usage

get_magnitude_values(magnitude, n_elements = 9L, max = NULL, min = NULL)

Arguments

magnitude

double Factor using for creating the magnitude.

n_elements

int Number of values to return.

max

double The maximal value.

min

double The minimal value.

Value

Returns a numeric vector with the generated values. The values are calculated with the following formula: max * magnitude^i for i=1,...,n_elements. Only values equal or greater min are returned.

See Also

Other Parameter Dictionary: BaseModelsIndex, DataSetsIndex, TokenizerIndex, doc_formula(), get_TEClassifiers_class_names(), get_called_args(), get_depr_obj_names(), get_param_def(), get_param_dict(), get_param_doc_desc()


aifeducation documentation built on Nov. 19, 2025, 5:08 p.m.