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 import java.util.MissingResourceException;
26 import java.util.ResourceBundle;
27
28 import org.hipparchus.exception.Localizable;
29 import org.hipparchus.exception.UTF8Control;
30
31 /**
32 * Enumeration for localized messages formats used in exceptions messages.
33 * <p>
34 * The constants in this enumeration represent the available
35 * formats as localized strings. These formats are intended to be
36 * localized using simple properties files, using the constant
37 * name as the key and the property value as the message format.
38 * The source English format is provided in the constants themselves
39 * to serve both as a reminder for developers to understand the parameters
40 * needed by each format, as a basis for translators to create
41 * localized properties files, and as a default format if some
42 * translation is missing.
43 * </p>
44 */
45 public enum LocalizedOptimFormats implements Localizable {
46
47 /** EQUAL_VERTICES_IN_SIMPLEX. */
48 EQUAL_VERTICES_IN_SIMPLEX("equal vertices {0} and {1} in simplex configuration"),
49
50 /** INVALID_IMPLEMENTATION. */
51 INVALID_IMPLEMENTATION("required functionality is missing in {0}"),
52
53 /** NO_FEASIBLE_SOLUTION. */
54 NO_FEASIBLE_SOLUTION("no feasible solution"),
55
56 /** SIMPLEX_NEED_ONE_POINT. */
57 SIMPLEX_NEED_ONE_POINT("simplex must contain at least one point"),
58
59 /** TOO_SMALL_COST_RELATIVE_TOLERANCE. */
60 TOO_SMALL_COST_RELATIVE_TOLERANCE("cost relative tolerance is too small ({0}), no further reduction in the sum of squares is possible"),
61
62 /** TOO_SMALL_ORTHOGONALITY_TOLERANCE. */
63 TOO_SMALL_ORTHOGONALITY_TOLERANCE("orthogonality tolerance is too small ({0}), solution is orthogonal to the jacobian"),
64
65 /** TOO_SMALL_PARAMETERS_RELATIVE_TOLERANCE. */
66 TOO_SMALL_PARAMETERS_RELATIVE_TOLERANCE("parameters relative tolerance is too small ({0}), no further improvement in the approximate solution is possible"),
67
68 /** TRUST_REGION_STEP_FAILED. */
69 TRUST_REGION_STEP_FAILED("trust region step has failed to reduce Q"),
70
71 /** UNABLE_TO_PERFORM_QR_DECOMPOSITION_ON_JACOBIAN. */
72 UNABLE_TO_PERFORM_QR_DECOMPOSITION_ON_JACOBIAN("unable to perform Q.R decomposition on the {0}x{1} jacobian matrix"),
73
74 /** UNABLE_TO_SOLVE_SINGULAR_PROBLEM. */
75 UNABLE_TO_SOLVE_SINGULAR_PROBLEM("unable to solve: singular problem"),
76
77 /** UNBOUNDED_SOLUTION. */
78 UNBOUNDED_SOLUTION("unbounded solution"),
79
80 /** CONSTRAINTS_RANK. */
81 CONSTRAINTS_RANK("rank of constraints must be lesser than domain dimension, but {0} >= {1}");
82
83 /** Source English format. */
84 private final String sourceFormat;
85
86 /** Simple constructor.
87 * @param sourceFormat source English format to use when no
88 * localized version is available
89 */
90 LocalizedOptimFormats(final String sourceFormat) {
91 this.sourceFormat = sourceFormat;
92 }
93
94 /** {@inheritDoc} */
95 @Override
96 public String getSourceString() {
97 return sourceFormat;
98 }
99
100 /** {@inheritDoc} */
101 @Override
102 public String getLocalizedString(final Locale locale) {
103 try {
104 final String path = LocalizedOptimFormats.class.getName().replaceAll("\\.", "/");
105 ResourceBundle bundle =
106 ResourceBundle.getBundle("assets/" + path, locale, new UTF8Control());
107 if (bundle.getLocale().getLanguage().equals(locale.getLanguage())) {
108 final String translated = bundle.getString(name());
109 if ((translated != null) &&
110 (translated.length() > 0) &&
111 (!translated.toLowerCase(locale).contains("missing translation"))) {
112 // the value of the resource is the translated format
113 return translated;
114 }
115 }
116
117 } catch (MissingResourceException mre) { // NOPMD
118 // do nothing here
119 }
120
121 // either the locale is not supported or the resource is unknown
122 // don't translate and fall back to using the source format
123 return sourceFormat;
124
125 }
126
127 }