Factory

pymoo.factory.get_algorithm(name, kwargs)

A convenience method to get a algorithm object just by providing a string.

Parameters
name{ ‘ga’, ‘brkga’, ‘de’, ‘nelder-mead’, ‘pattern-search’, ‘cmaes’, ‘pso’, ‘nsga2’, ‘rnsga2’, ‘nsga3’, ‘unsga3’, ‘rnsga3’, ‘moead’, ‘ctaea’ }

Name of the algorithm.

kwargsdict

Dictionary that should be used to call the method mapped to the algorithm factory function.

Returns
classAlgorithm

An algorithm object based on the string. None if the algorithm was not found.

pymoo.factory.get_sampling(name, kwargs)

A convenience method to get a sampling object just by providing a string.

Parameters
name{ ‘real_random’, ‘real_lhs’, ‘bin_random’, ‘int_random’, ‘int_lhs’, ‘perm_random’ }

Name of the sampling.

kwargsdict

Dictionary that should be used to call the method mapped to the sampling factory function.

Returns
classSampling

An sampling object based on the string. None if the sampling was not found.

pymoo.factory.get_selection(name, kwargs)

A convenience method to get a selection object just by providing a string.

Parameters
name{ ‘random’, ‘tournament’ }

Name of the selection.

kwargsdict

Dictionary that should be used to call the method mapped to the selection factory function.

Returns
classSelection

An selection object based on the string. None if the selection was not found.

pymoo.factory.get_crossover(name, kwargs)

A convenience method to get a crossover object just by providing a string.

Parameters
name{ ‘real_sbx’, ‘int_sbx’, ‘real_de’, ‘real_pcx’, ‘(real|bin|int)_ux’, ‘(bin|int)_hux’, ‘(real|bin|int)_exp’, ‘(real|bin|int)_one_point’, ‘(real|bin|int)_two_point’, ‘(real|bin|int)_k_point’, ‘perm_ox’, ‘perm_erx’ }

Name of the crossover.

kwargsdict

Dictionary that should be used to call the method mapped to the crossover factory function.

Returns
classCrossover

An crossover object based on the string. None if the crossover was not found.

pymoo.factory.get_mutation(name, kwargs)

A convenience method to get a mutation object just by providing a string.

Parameters
name{ ‘none’, ‘real_pm’, ‘int_pm’, ‘bin_bitflip’, ‘perm_inv’ }

Name of the mutation.

kwargsdict

Dictionary that should be used to call the method mapped to the mutation factory function.

Returns
classMutation

An mutation object based on the string. None if the mutation was not found.

pymoo.factory.get_termination(name, kwargs)

A convenience method to get a termination object just by providing a string.

Parameters
name{ ‘n_eval’, ‘(n_gen|n_iter)’, ‘igd’, ‘time’, ‘(x_tol|xtol)’, ‘(f_tol$|ftol$)’, ‘(f_tol_s|ftol_s)’, ‘(default$|default_multi)’, ‘default_single$’ }

Name of the termination.

kwargsdict

Dictionary that should be used to call the method mapped to the termination factory function.

Returns
classtermination

An termination object based on the string. None if the termination was not found.