1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.optim;
23
24 import java.util.Locale;
25
26 import org.hipparchus.exception.Localizable;
27
28 /**
29 * Enumeration for localized messages formats used in exceptions messages.
30 * <p>
31 * The constants in this enumeration represent the available
32 * formats as localized strings. These formats are intended to be
33 * localized using simple properties files, using the constant
34 * name as the key and the property value as the message format.
35 * The source English format is provided in the constants themselves
36 * to serve both as a reminder for developers to understand the parameters
37 * needed by each format, as a basis for translators to create
38 * localized properties files, and as a default format if some
39 * translation is missing.
40 * </p>
41 */
42 public enum LocalizedOptimFormats implements Localizable {
43
44 /** EQUAL_VERTICES_IN_SIMPLEX. */
45 EQUAL_VERTICES_IN_SIMPLEX("equal vertices {0} and {1} in simplex configuration"),
46
47 /** INVALID_IMPLEMENTATION. */
48 INVALID_IMPLEMENTATION("required functionality is missing in {0}"),
49
50 /** NO_FEASIBLE_SOLUTION. */
51 NO_FEASIBLE_SOLUTION("no feasible solution"),
52
53 /** SIMPLEX_NEED_ONE_POINT. */
54 SIMPLEX_NEED_ONE_POINT("simplex must contain at least one point"),
55
56 /** TOO_SMALL_COST_RELATIVE_TOLERANCE. */
57 TOO_SMALL_COST_RELATIVE_TOLERANCE("cost relative tolerance is too small ({0}), no further reduction in the sum of squares is possible"),
58
59 /** TOO_SMALL_ORTHOGONALITY_TOLERANCE. */
60 TOO_SMALL_ORTHOGONALITY_TOLERANCE("orthogonality tolerance is too small ({0}), solution is orthogonal to the jacobian"),
61
62 /** TOO_SMALL_PARAMETERS_RELATIVE_TOLERANCE. */
63 TOO_SMALL_PARAMETERS_RELATIVE_TOLERANCE("parameters relative tolerance is too small ({0}), no further improvement in the approximate solution is possible"),
64
65 /** TRUST_REGION_STEP_FAILED. */
66 TRUST_REGION_STEP_FAILED("trust region step has failed to reduce Q"),
67
68 /** UNABLE_TO_PERFORM_QR_DECOMPOSITION_ON_JACOBIAN. */
69 UNABLE_TO_PERFORM_QR_DECOMPOSITION_ON_JACOBIAN("unable to perform Q.R decomposition on the {0}x{1} jacobian matrix"),
70
71 /** UNABLE_TO_SOLVE_SINGULAR_PROBLEM. */
72 UNABLE_TO_SOLVE_SINGULAR_PROBLEM("unable to solve: singular problem"),
73
74 /** UNBOUNDED_SOLUTION. */
75 UNBOUNDED_SOLUTION("unbounded solution"),
76
77 /** CONSTRAINTS_RANK. */
78 CONSTRAINTS_RANK("rank of constraints must be lesser than domain dimension, but {0} >= {1}");
79
80 /** Source English format. */
81 private final String sourceFormat;
82
83 /** Simple constructor.
84 * @param sourceFormat source English format to use when no
85 * localized version is available
86 */
87 LocalizedOptimFormats(final String sourceFormat) {
88 this.sourceFormat = sourceFormat;
89 }
90
91 /** {@inheritDoc} */
92 @Override
93 public String getSourceString() {
94 return sourceFormat;
95 }
96
97 /** {@inheritDoc} */
98 @Override
99 public String getLocalizedString(final Locale locale) {
100 return getLocalizedString("assets/" + LocalizedOptimFormats.class.getName().replaceAll("\\.", "/"),
101 name(), locale);
102 }
103
104 }