View Javadoc

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    *      http://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  package org.apache.commons.math3.exception.util;
18  
19  import java.util.Locale;
20  import java.util.MissingResourceException;
21  import java.util.ResourceBundle;
22  
23  /**
24   * Enumeration for localized messages formats used in exceptions messages.
25   * <p>
26   * The constants in this enumeration represent the available
27   * formats as localized strings. These formats are intended to be
28   * localized using simple properties files, using the constant
29   * name as the key and the property value as the message format.
30   * The source English format is provided in the constants themselves
31   * to serve both as a reminder for developers to understand the parameters
32   * needed by each format, as a basis for translators to create
33   * localized properties files, and as a default format if some
34   * translation is missing.
35   * </p>
36   * @since 2.2
37   * @version $Id: LocalizedFormats.java 1536683 2013-10-29 12:01:12Z erans $
38   */
39  public enum LocalizedFormats implements Localizable {
40  
41      // CHECKSTYLE: stop MultipleVariableDeclarations
42      // CHECKSTYLE: stop JavadocVariable
43  
44      ARGUMENT_OUTSIDE_DOMAIN("Argument {0} outside domain [{1} ; {2}]"),
45      ARRAY_SIZE_EXCEEDS_MAX_VARIABLES("array size cannot be greater than {0}"),
46      ARRAY_SIZES_SHOULD_HAVE_DIFFERENCE_1("array sizes should have difference 1 ({0} != {1} + 1)"),
47      ARRAY_SUMS_TO_ZERO("array sums to zero"),
48      ASSYMETRIC_EIGEN_NOT_SUPPORTED("eigen decomposition of assymetric matrices not supported yet"),
49      AT_LEAST_ONE_COLUMN("matrix must have at least one column"),
50      AT_LEAST_ONE_ROW("matrix must have at least one row"),
51      BANDWIDTH("bandwidth ({0})"),
52      BINOMIAL_INVALID_PARAMETERS_ORDER("must have n >= k for binomial coefficient (n, k), got k = {0}, n = {1}"),
53      BINOMIAL_NEGATIVE_PARAMETER("must have n >= 0 for binomial coefficient (n, k), got n = {0}"),
54      CANNOT_CLEAR_STATISTIC_CONSTRUCTED_FROM_EXTERNAL_MOMENTS("statistics constructed from external moments cannot be cleared"),
55      CANNOT_COMPUTE_0TH_ROOT_OF_UNITY("cannot compute 0-th root of unity, indefinite result"),
56      CANNOT_COMPUTE_BETA_DENSITY_AT_0_FOR_SOME_ALPHA("cannot compute beta density at 0 when alpha = {0,number}"),
57      CANNOT_COMPUTE_BETA_DENSITY_AT_1_FOR_SOME_BETA("cannot compute beta density at 1 when beta = %.3g"),
58      CANNOT_COMPUTE_NTH_ROOT_FOR_NEGATIVE_N("cannot compute nth root for null or negative n: {0}"),
59      CANNOT_DISCARD_NEGATIVE_NUMBER_OF_ELEMENTS("cannot discard a negative number of elements ({0})"),
60      CANNOT_FORMAT_INSTANCE_AS_3D_VECTOR("cannot format a {0} instance as a 3D vector"),
61      CANNOT_FORMAT_INSTANCE_AS_COMPLEX("cannot format a {0} instance as a complex number"),
62      CANNOT_FORMAT_INSTANCE_AS_REAL_VECTOR("cannot format a {0} instance as a real vector"),
63      CANNOT_FORMAT_OBJECT_TO_FRACTION("cannot format given object as a fraction number"),
64      CANNOT_INCREMENT_STATISTIC_CONSTRUCTED_FROM_EXTERNAL_MOMENTS("statistics constructed from external moments cannot be incremented"),
65      CANNOT_NORMALIZE_A_ZERO_NORM_VECTOR("cannot normalize a zero norm vector"),
66      CANNOT_RETRIEVE_AT_NEGATIVE_INDEX("elements cannot be retrieved from a negative array index {0}"),
67      CANNOT_SET_AT_NEGATIVE_INDEX("cannot set an element at a negative index {0}"),
68      CANNOT_SUBSTITUTE_ELEMENT_FROM_EMPTY_ARRAY("cannot substitute an element from an empty array"),
69      CANNOT_TRANSFORM_TO_DOUBLE("Conversion Exception in Transformation: {0}"),
70      CARDAN_ANGLES_SINGULARITY("Cardan angles singularity"),
71      CLASS_DOESNT_IMPLEMENT_COMPARABLE("class ({0}) does not implement Comparable"),
72      CLOSEST_ORTHOGONAL_MATRIX_HAS_NEGATIVE_DETERMINANT("the closest orthogonal matrix has a negative determinant {0}"),
73      COLUMN_INDEX_OUT_OF_RANGE("column index {0} out of allowed range [{1}, {2}]"),
74      COLUMN_INDEX("column index ({0})"), /* keep */
75      CONSTRAINT("constraint"), /* keep */
76      CONTINUED_FRACTION_INFINITY_DIVERGENCE("Continued fraction convergents diverged to +/- infinity for value {0}"),
77      CONTINUED_FRACTION_NAN_DIVERGENCE("Continued fraction diverged to NaN for value {0}"),
78      CONTRACTION_CRITERIA_SMALLER_THAN_EXPANSION_FACTOR("contraction criteria ({0}) smaller than the expansion factor ({1}).  This would lead to a never ending loop of expansion and contraction as a newly expanded internal storage array would immediately satisfy the criteria for contraction."),
79      CONTRACTION_CRITERIA_SMALLER_THAN_ONE("contraction criteria smaller than one ({0}).  This would lead to a never ending loop of expansion and contraction as an internal storage array length equal to the number of elements would satisfy the contraction criteria."),
80      CONVERGENCE_FAILED("convergence failed"), /* keep */
81      CROSSING_BOUNDARY_LOOPS("some outline boundary loops cross each other"),
82      CROSSOVER_RATE("crossover rate ({0})"),
83      CUMULATIVE_PROBABILITY_RETURNED_NAN("Cumulative probability function returned NaN for argument {0} p = {1}"),
84      DIFFERENT_ROWS_LENGTHS("some rows have length {0} while others have length {1}"),
85      DIFFERENT_ORIG_AND_PERMUTED_DATA("original and permuted data must contain the same elements"),
86      DIGEST_NOT_INITIALIZED("digest not initialized"),
87      DIMENSIONS_MISMATCH_2x2("got {0}x{1} but expected {2}x{3}"), /* keep */
88      DIMENSIONS_MISMATCH_SIMPLE("{0} != {1}"), /* keep */
89      DIMENSIONS_MISMATCH("dimensions mismatch"), /* keep */
90      DISCRETE_CUMULATIVE_PROBABILITY_RETURNED_NAN("Discrete cumulative probability function returned NaN for argument {0}"),
91      DISTRIBUTION_NOT_LOADED("distribution not loaded"),
92      DUPLICATED_ABSCISSA_DIVISION_BY_ZERO("duplicated abscissa {0} causes division by zero"),
93      ELITISM_RATE("elitism rate ({0})"),
94      EMPTY_CLUSTER_IN_K_MEANS("empty cluster in k-means"),
95      EMPTY_INTERPOLATION_SAMPLE("sample for interpolation is empty"),
96      EMPTY_POLYNOMIALS_COEFFICIENTS_ARRAY("empty polynomials coefficients array"), /* keep */
97      EMPTY_SELECTED_COLUMN_INDEX_ARRAY("empty selected column index array"),
98      EMPTY_SELECTED_ROW_INDEX_ARRAY("empty selected row index array"),
99      EMPTY_STRING_FOR_IMAGINARY_CHARACTER("empty string for imaginary character"),
100     ENDPOINTS_NOT_AN_INTERVAL("endpoints do not specify an interval: [{0}, {1}]"),
101     EQUAL_VERTICES_IN_SIMPLEX("equal vertices {0} and {1} in simplex configuration"),
102     EULER_ANGLES_SINGULARITY("Euler angles singularity"),
103     EVALUATION("evaluation"), /* keep */
104     EXPANSION_FACTOR_SMALLER_THAN_ONE("expansion factor smaller than one ({0})"),
105     FACTORIAL_NEGATIVE_PARAMETER("must have n >= 0 for n!, got n = {0}"),
106     FAILED_BRACKETING("number of iterations={4}, maximum iterations={5}, initial={6}, lower bound={7}, upper bound={8}, final a value={0}, final b value={1}, f(a)={2}, f(b)={3}"),
107     FAILED_FRACTION_CONVERSION("Unable to convert {0} to fraction after {1} iterations"),
108     FIRST_COLUMNS_NOT_INITIALIZED_YET("first {0} columns are not initialized yet"),
109     FIRST_ELEMENT_NOT_ZERO("first element is not 0: {0}"),
110     FIRST_ROWS_NOT_INITIALIZED_YET("first {0} rows are not initialized yet"),
111     FRACTION_CONVERSION_OVERFLOW("Overflow trying to convert {0} to fraction ({1}/{2})"),
112     FUNCTION_NOT_DIFFERENTIABLE("function is not differentiable"),
113     FUNCTION_NOT_POLYNOMIAL("function is not polynomial"),
114     GCD_OVERFLOW_32_BITS("overflow: gcd({0}, {1}) is 2^31"),
115     GCD_OVERFLOW_64_BITS("overflow: gcd({0}, {1}) is 2^63"),
116     HOLE_BETWEEN_MODELS_TIME_RANGES("{0} wide hole between models time ranges"),
117     ILL_CONDITIONED_OPERATOR("condition number {1} is too high "),
118     INDEX_LARGER_THAN_MAX("the index specified: {0} is larger than the current maximal index {1}"),
119     INDEX_NOT_POSITIVE("index ({0}) is not positive"),
120     INDEX_OUT_OF_RANGE("index {0} out of allowed range [{1}, {2}]"),
121     INDEX("index ({0})"), /* keep */
122     NOT_FINITE_NUMBER("{0} is not a finite number"), /* keep */
123     INFINITE_BOUND("interval bounds must be finite"),
124     ARRAY_ELEMENT("value {0} at index {1}"), /* keep */
125     INFINITE_ARRAY_ELEMENT("Array contains an infinite element, {0} at index {1}"),
126     INFINITE_VALUE_CONVERSION("cannot convert infinite value"),
127     INITIAL_CAPACITY_NOT_POSITIVE("initial capacity ({0}) is not positive"),
128     INITIAL_COLUMN_AFTER_FINAL_COLUMN("initial column {1} after final column {0}"),
129     INITIAL_ROW_AFTER_FINAL_ROW("initial row {1} after final row {0}"),
130     @Deprecated
131     INPUT_DATA_FROM_UNSUPPORTED_DATASOURCE("input data comes from unsupported datasource: {0}, supported sources: {1}, {2}"),
132     INSTANCES_NOT_COMPARABLE_TO_EXISTING_VALUES("instance of class {0} not comparable to existing values"),
133     INSUFFICIENT_DATA_FOR_T_STATISTIC("insufficient data for t statistic, needs at least 2, got {0}"),
134     INSUFFICIENT_DIMENSION("insufficient dimension {0}, must be at least {1}"),
135     DIMENSION("dimension ({0})"), /* keep */
136     INSUFFICIENT_OBSERVED_POINTS_IN_SAMPLE("sample contains {0} observed points, at least {1} are required"),
137     INSUFFICIENT_ROWS_AND_COLUMNS("insufficient data: only {0} rows and {1} columns."),
138     INTEGRATION_METHOD_NEEDS_AT_LEAST_TWO_PREVIOUS_POINTS("multistep method needs at least {0} previous steps, got {1}"),
139     INTERNAL_ERROR("internal error, please fill a bug report at {0}"),
140     INVALID_BINARY_DIGIT("invalid binary digit: {0}"),
141     INVALID_BINARY_CHROMOSOME("binary mutation works on BinaryChromosome only"),
142     INVALID_BRACKETING_PARAMETERS("invalid bracketing parameters:  lower bound={0},  initial={1}, upper bound={2}"),
143     INVALID_FIXED_LENGTH_CHROMOSOME("one-point crossover only works with fixed-length chromosomes"),
144     INVALID_INTERVAL_INITIAL_VALUE_PARAMETERS("invalid interval, initial value parameters:  lower={0}, initial={1}, upper={2}"),
145     INVALID_ITERATIONS_LIMITS("invalid iteration limits: min={0}, max={1}"),
146     INVALID_MAX_ITERATIONS("bad value for maximum iterations number: {0}"),
147     NOT_ENOUGH_DATA_REGRESSION("the number of observations is not sufficient to conduct regression"),
148     INVALID_REGRESSION_ARRAY("input data array length = {0} does not match the number of observations = {1} and the number of regressors = {2}"),
149     INVALID_REGRESSION_OBSERVATION("length of regressor array = {0} does not match the number of variables = {1} in the model"),
150     INVALID_ROUNDING_METHOD("invalid rounding method {0}, valid methods: {1} ({2}), {3} ({4}), {5} ({6}), {7} ({8}), {9} ({10}), {11} ({12}), {13} ({14}), {15} ({16})"),
151     ITERATOR_EXHAUSTED("iterator exhausted"),
152     ITERATIONS("iterations"), /* keep */
153     LCM_OVERFLOW_32_BITS("overflow: lcm({0}, {1}) is 2^31"),
154     LCM_OVERFLOW_64_BITS("overflow: lcm({0}, {1}) is 2^63"),
155     LIST_OF_CHROMOSOMES_BIGGER_THAN_POPULATION_SIZE("list of chromosomes bigger than maxPopulationSize"),
156     LOESS_EXPECTS_AT_LEAST_ONE_POINT("Loess expects at least 1 point"),
157     LOWER_BOUND_NOT_BELOW_UPPER_BOUND("lower bound ({0}) must be strictly less than upper bound ({1})"), /* keep */
158     LOWER_ENDPOINT_ABOVE_UPPER_ENDPOINT("lower endpoint ({0}) must be less than or equal to upper endpoint ({1})"),
159     MAP_MODIFIED_WHILE_ITERATING("map has been modified while iterating"),
160     EVALUATIONS("evaluations"), /* keep */
161     MAX_COUNT_EXCEEDED("maximal count ({0}) exceeded"), /* keep */
162     MAX_ITERATIONS_EXCEEDED("maximal number of iterations ({0}) exceeded"),
163     MINIMAL_STEPSIZE_REACHED_DURING_INTEGRATION("minimal step size ({1,number,0.00E00}) reached, integration needs {0,number,0.00E00}"),
164     MISMATCHED_LOESS_ABSCISSA_ORDINATE_ARRAYS("Loess expects the abscissa and ordinate arrays to be of the same size, but got {0} abscissae and {1} ordinatae"),
165     MUTATION_RATE("mutation rate ({0})"),
166     NAN_ELEMENT_AT_INDEX("element {0} is NaN"),
167     NAN_VALUE_CONVERSION("cannot convert NaN value"),
168     NEGATIVE_BRIGHTNESS_EXPONENT("brightness exponent should be positive or null, but got {0}"),
169     NEGATIVE_COMPLEX_MODULE("negative complex module {0}"),
170     NEGATIVE_ELEMENT_AT_2D_INDEX("element ({0}, {1}) is negative: {2}"),
171     NEGATIVE_ELEMENT_AT_INDEX("element {0} is negative: {1}"),
172     NEGATIVE_NUMBER_OF_SUCCESSES("number of successes must be non-negative ({0})"),
173     NUMBER_OF_SUCCESSES("number of successes ({0})"), /* keep */
174     NEGATIVE_NUMBER_OF_TRIALS("number of trials must be non-negative ({0})"),
175     NUMBER_OF_INTERPOLATION_POINTS("number of interpolation points ({0})"), /* keep */
176     NUMBER_OF_TRIALS("number of trials ({0})"),
177     ROBUSTNESS_ITERATIONS("number of robustness iterations ({0})"),
178     START_POSITION("start position ({0})"), /* keep */
179     NON_CONVERGENT_CONTINUED_FRACTION("Continued fraction convergents failed to converge (in less than {0} iterations) for value {1}"),
180     NON_INVERTIBLE_TRANSFORM("non-invertible affine transform collapses some lines into single points"),
181     NON_POSITIVE_MICROSPHERE_ELEMENTS("number of microsphere elements must be positive, but got {0}"),
182     NON_POSITIVE_POLYNOMIAL_DEGREE("polynomial degree must be positive: degree={0}"),
183     NON_REAL_FINITE_ABSCISSA("all abscissae must be finite real numbers, but {0}-th is {1}"),
184     NON_REAL_FINITE_ORDINATE("all ordinatae must be finite real numbers, but {0}-th is {1}"),
185     NON_REAL_FINITE_WEIGHT("all weights must be finite real numbers, but {0}-th is {1}"),
186     NON_SQUARE_MATRIX("non square ({0}x{1}) matrix"),
187     NORM("Norm ({0})"), /* keep */
188     NORMALIZE_INFINITE("Cannot normalize to an infinite value"),
189     NORMALIZE_NAN("Cannot normalize to NaN"),
190     NOT_ADDITION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not addition compatible"),
191     NOT_DECREASING_NUMBER_OF_POINTS("points {0} and {1} are not decreasing ({2} < {3})"),
192     NOT_DECREASING_SEQUENCE("points {3} and {2} are not decreasing ({1} < {0})"), /* keep */
193     NOT_ENOUGH_DATA_FOR_NUMBER_OF_PREDICTORS("not enough data ({0} rows) for this many predictors ({1} predictors)"),
194     NOT_ENOUGH_POINTS_IN_SPLINE_PARTITION("spline partition must have at least {0} points, got {1}"),
195     NOT_INCREASING_NUMBER_OF_POINTS("points {0} and {1} are not increasing ({2} > {3})"),
196     NOT_INCREASING_SEQUENCE("points {3} and {2} are not increasing ({1} > {0})"), /* keep */
197     NOT_MULTIPLICATION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not multiplication compatible"),
198     NOT_POSITIVE_DEFINITE_MATRIX("not positive definite matrix"), /* keep */
199     NON_POSITIVE_DEFINITE_MATRIX("not positive definite matrix: diagonal element at ({1},{1}) is smaller than {2} ({0})"),
200     NON_POSITIVE_DEFINITE_OPERATOR("non positive definite linear operator"), /* keep */
201     NON_SELF_ADJOINT_OPERATOR("non self-adjoint linear operator"), /* keep */
202     NON_SQUARE_OPERATOR("non square ({0}x{1}) linear operator"), /* keep */
203     DEGREES_OF_FREEDOM("degrees of freedom ({0})"), /* keep */
204     NOT_POSITIVE_DEGREES_OF_FREEDOM("degrees of freedom must be positive ({0})"),
205     NOT_POSITIVE_ELEMENT_AT_INDEX("element {0} is not positive: {1}"),
206     NOT_POSITIVE_EXPONENT("invalid exponent {0} (must be positive)"),
207     NUMBER_OF_ELEMENTS_SHOULD_BE_POSITIVE("number of elements should be positive ({0})"),
208     BASE("base ({0})"), /* keep */
209     EXPONENT("exponent ({0})"), /* keep */
210     NOT_POSITIVE_LENGTH("length must be positive ({0})"),
211     LENGTH("length ({0})"), /* keep */
212     NOT_POSITIVE_MEAN("mean must be positive ({0})"),
213     MEAN("mean ({0})"), /* keep */
214     NOT_POSITIVE_NUMBER_OF_SAMPLES("number of sample is not positive: {0}"),
215     NUMBER_OF_SAMPLES("number of samples ({0})"), /* keep */
216     NOT_POSITIVE_PERMUTATION("permutation k ({0}) must be positive"),
217     PERMUTATION_SIZE("permutation size ({0}"), /* keep */
218     NOT_POSITIVE_POISSON_MEAN("the Poisson mean must be positive ({0})"),
219     NOT_POSITIVE_POPULATION_SIZE("population size must be positive ({0})"),
220     POPULATION_SIZE("population size ({0})"), /* keep */
221     NOT_POSITIVE_ROW_DIMENSION("invalid row dimension: {0} (must be positive)"),
222     NOT_POSITIVE_SAMPLE_SIZE("sample size must be positive ({0})"),
223     NOT_POSITIVE_SCALE("scale must be positive ({0})"),
224     SCALE("scale ({0})"), /* keep */
225     NOT_POSITIVE_SHAPE("shape must be positive ({0})"),
226     SHAPE("shape ({0})"), /* keep */
227     NOT_POSITIVE_STANDARD_DEVIATION("standard deviation must be positive ({0})"),
228     STANDARD_DEVIATION("standard deviation ({0})"), /* keep */
229     NOT_POSITIVE_UPPER_BOUND("upper bound must be positive ({0})"),
230     NOT_POSITIVE_WINDOW_SIZE("window size must be positive ({0})"),
231     NOT_POWER_OF_TWO("{0} is not a power of 2"),
232     NOT_POWER_OF_TWO_CONSIDER_PADDING("{0} is not a power of 2, consider padding for fix"),
233     NOT_POWER_OF_TWO_PLUS_ONE("{0} is not a power of 2 plus one"),
234     NOT_STRICTLY_DECREASING_NUMBER_OF_POINTS("points {0} and {1} are not strictly decreasing ({2} <= {3})"),
235     NOT_STRICTLY_DECREASING_SEQUENCE("points {3} and {2} are not strictly decreasing ({1} <= {0})"), /* keep */
236     NOT_STRICTLY_INCREASING_KNOT_VALUES("knot values must be strictly increasing"),
237     NOT_STRICTLY_INCREASING_NUMBER_OF_POINTS("points {0} and {1} are not strictly increasing ({2} >= {3})"),
238     NOT_STRICTLY_INCREASING_SEQUENCE("points {3} and {2} are not strictly increasing ({1} >= {0})"), /* keep */
239     NOT_SUBTRACTION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not subtraction compatible"),
240     NOT_SUPPORTED_IN_DIMENSION_N("method not supported in dimension {0}"),
241     NOT_SYMMETRIC_MATRIX("not symmetric matrix"),
242     NON_SYMMETRIC_MATRIX("non symmetric matrix: the difference between entries at ({0},{1}) and ({1},{0}) is larger than {2}"), /* keep */
243     NO_BIN_SELECTED("no bin selected"),
244     NO_CONVERGENCE_WITH_ANY_START_POINT("none of the {0} start points lead to convergence"), /* keep */
245     NO_DATA("no data"), /* keep */
246     NO_DEGREES_OF_FREEDOM("no degrees of freedom ({0} measurements, {1} parameters)"),
247     NO_DENSITY_FOR_THIS_DISTRIBUTION("This distribution does not have a density function implemented"),
248     NO_FEASIBLE_SOLUTION("no feasible solution"),
249     NO_OPTIMUM_COMPUTED_YET("no optimum computed yet"), /* keep */
250     NO_REGRESSORS("Regression model must include at least one regressor"),
251     NO_RESULT_AVAILABLE("no result available"),
252     NO_SUCH_MATRIX_ENTRY("no entry at indices ({0}, {1}) in a {2}x{3} matrix"),
253     NAN_NOT_ALLOWED("NaN is not allowed"),
254     NULL_NOT_ALLOWED("null is not allowed"), /* keep */
255     ARRAY_ZERO_LENGTH_OR_NULL_NOT_ALLOWED("a null or zero length array not allowed"),
256     COVARIANCE_MATRIX("covariance matrix"), /* keep */
257     DENOMINATOR("denominator"), /* keep */
258     DENOMINATOR_FORMAT("denominator format"), /* keep */
259     FRACTION("fraction"), /* keep */
260     FUNCTION("function"), /* keep */
261     IMAGINARY_FORMAT("imaginary format"), /* keep */
262     INPUT_ARRAY("input array"), /* keep */
263     NUMERATOR("numerator"), /* keep */
264     NUMERATOR_FORMAT("numerator format"), /* keep */
265     OBJECT_TRANSFORMATION("conversion exception in transformation"), /* keep */
266     REAL_FORMAT("real format"), /* keep */
267     WHOLE_FORMAT("whole format"), /* keep */
268     NUMBER_TOO_LARGE("{0} is larger than the maximum ({1})"), /* keep */
269     NUMBER_TOO_SMALL("{0} is smaller than the minimum ({1})"), /* keep */
270     NUMBER_TOO_LARGE_BOUND_EXCLUDED("{0} is larger than, or equal to, the maximum ({1})"), /* keep */
271     NUMBER_TOO_SMALL_BOUND_EXCLUDED("{0} is smaller than, or equal to, the minimum ({1})"), /* keep */
272     NUMBER_OF_SUCCESS_LARGER_THAN_POPULATION_SIZE("number of successes ({0}) must be less than or equal to population size ({1})"),
273     NUMERATOR_OVERFLOW_AFTER_MULTIPLY("overflow, numerator too large after multiply: {0}"),
274     N_POINTS_GAUSS_LEGENDRE_INTEGRATOR_NOT_SUPPORTED("{0} points Legendre-Gauss integrator not supported, number of points must be in the {1}-{2} range"),
275     OBSERVED_COUNTS_ALL_ZERO("observed counts are all 0 in observed array {0}"),
276     OBSERVED_COUNTS_BOTTH_ZERO_FOR_ENTRY("observed counts are both zero for entry {0}"),
277     BOBYQA_BOUND_DIFFERENCE_CONDITION("the difference between the upper and lower bound must be larger than twice the initial trust region radius ({0})"),
278     OUT_OF_BOUNDS_QUANTILE_VALUE("out of bounds quantile value: {0}, must be in (0, 100]"),
279     OUT_OF_BOUNDS_CONFIDENCE_LEVEL("out of bounds confidence level {0}, must be between {1} and {2}"),
280     OUT_OF_BOUND_SIGNIFICANCE_LEVEL("out of bounds significance level {0}, must be between {1} and {2}"),
281     SIGNIFICANCE_LEVEL("significance level ({0})"), /* keep */
282     OUT_OF_ORDER_ABSCISSA_ARRAY("the abscissae array must be sorted in a strictly increasing order, but the {0}-th element is {1} whereas {2}-th is {3}"),
283     OUT_OF_RANGE_ROOT_OF_UNITY_INDEX("out of range root of unity index {0} (must be in [{1};{2}])"),
284     OUT_OF_RANGE("out of range"), /* keep */
285     OUT_OF_RANGE_SIMPLE("{0} out of [{1}, {2}] range"), /* keep */
286     OUT_OF_RANGE_LEFT("{0} out of ({1}, {2}] range"),
287     OUT_OF_RANGE_RIGHT("{0} out of [{1}, {2}) range"),
288     OUTLINE_BOUNDARY_LOOP_OPEN("an outline boundary loop is open"),
289     OVERFLOW("overflow"), /* keep */
290     OVERFLOW_IN_FRACTION("overflow in fraction {0}/{1}, cannot negate"),
291     OVERFLOW_IN_ADDITION("overflow in addition: {0} + {1}"),
292     OVERFLOW_IN_SUBTRACTION("overflow in subtraction: {0} - {1}"),
293     PERCENTILE_IMPLEMENTATION_CANNOT_ACCESS_METHOD("cannot access {0} method in percentile implementation {1}"),
294     PERCENTILE_IMPLEMENTATION_UNSUPPORTED_METHOD("percentile implementation {0} does not support {1}"),
295     PERMUTATION_EXCEEDS_N("permutation size ({0}) exceeds permuation domain ({1})"), /* keep */
296     POLYNOMIAL("polynomial"), /* keep */
297     POLYNOMIAL_INTERPOLANTS_MISMATCH_SEGMENTS("number of polynomial interpolants must match the number of segments ({0} != {1} - 1)"),
298     POPULATION_LIMIT_NOT_POSITIVE("population limit has to be positive"),
299     POWER_NEGATIVE_PARAMETERS("cannot raise an integral value to a negative power ({0}^{1})"),
300     PROPAGATION_DIRECTION_MISMATCH("propagation direction mismatch"),
301     RANDOMKEY_MUTATION_WRONG_CLASS("RandomKeyMutation works only with RandomKeys, not {0}"),
302     ROOTS_OF_UNITY_NOT_COMPUTED_YET("roots of unity have not been computed yet"),
303     ROTATION_MATRIX_DIMENSIONS("a {0}x{1} matrix cannot be a rotation matrix"),
304     ROW_INDEX_OUT_OF_RANGE("row index {0} out of allowed range [{1}, {2}]"),
305     ROW_INDEX("row index ({0})"), /* keep */
306     SAME_SIGN_AT_ENDPOINTS("function values at endpoints do not have different signs, endpoints: [{0}, {1}], values: [{2}, {3}]"),
307     SAMPLE_SIZE_EXCEEDS_COLLECTION_SIZE("sample size ({0}) exceeds collection size ({1})"), /* keep */
308     SAMPLE_SIZE_LARGER_THAN_POPULATION_SIZE("sample size ({0}) must be less than or equal to population size ({1})"),
309     SIMPLEX_NEED_ONE_POINT("simplex must contain at least one point"),
310     SIMPLE_MESSAGE("{0}"),
311     SINGULAR_MATRIX("matrix is singular"), /* keep */
312     SINGULAR_OPERATOR("operator is singular"),
313     SUBARRAY_ENDS_AFTER_ARRAY_END("subarray ends after array end"),
314     TOO_LARGE_CUTOFF_SINGULAR_VALUE("cutoff singular value is {0}, should be at most {1}"),
315     TOO_LARGE_TOURNAMENT_ARITY("tournament arity ({0}) cannot be bigger than population size ({1})"),
316     TOO_MANY_ELEMENTS_TO_DISCARD_FROM_ARRAY("cannot discard {0} elements from a {1} elements array"),
317     TOO_MANY_REGRESSORS("too many regressors ({0}) specified, only {1} in the model"),
318     TOO_SMALL_COST_RELATIVE_TOLERANCE("cost relative tolerance is too small ({0}), no further reduction in the sum of squares is possible"),
319     TOO_SMALL_INTEGRATION_INTERVAL("too small integration interval: length = {0}"),
320     TOO_SMALL_ORTHOGONALITY_TOLERANCE("orthogonality tolerance is too small ({0}), solution is orthogonal to the jacobian"),
321     TOO_SMALL_PARAMETERS_RELATIVE_TOLERANCE("parameters relative tolerance is too small ({0}), no further improvement in the approximate solution is possible"),
322     TRUST_REGION_STEP_FAILED("trust region step has failed to reduce Q"),
323     TWO_OR_MORE_CATEGORIES_REQUIRED("two or more categories required, got {0}"),
324     TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED("two or more values required in each category, one has {0}"),
325     UNABLE_TO_BRACKET_OPTIMUM_IN_LINE_SEARCH("unable to bracket optimum in line search"),
326     UNABLE_TO_COMPUTE_COVARIANCE_SINGULAR_PROBLEM("unable to compute covariances: singular problem"),
327     UNABLE_TO_FIRST_GUESS_HARMONIC_COEFFICIENTS("unable to first guess the harmonic coefficients"),
328     UNABLE_TO_ORTHOGONOLIZE_MATRIX("unable to orthogonalize matrix in {0} iterations"),
329     UNABLE_TO_PERFORM_QR_DECOMPOSITION_ON_JACOBIAN("unable to perform Q.R decomposition on the {0}x{1} jacobian matrix"),
330     UNABLE_TO_SOLVE_SINGULAR_PROBLEM("unable to solve: singular problem"),
331     UNBOUNDED_SOLUTION("unbounded solution"),
332     UNKNOWN_MODE("unknown mode {0}, known modes: {1} ({2}), {3} ({4}), {5} ({6}), {7} ({8}), {9} ({10}) and {11} ({12})"),
333     UNKNOWN_PARAMETER("unknown parameter {0}"),
334     UNMATCHED_ODE_IN_EXPANDED_SET("ode does not match the main ode set in the extended set"),
335     CANNOT_PARSE_AS_TYPE("string \"{0}\" unparseable (from position {1}) as an object of type {2}"), /* keep */
336     CANNOT_PARSE("string \"{0}\" unparseable (from position {1})"), /* keep */
337     UNPARSEABLE_3D_VECTOR("unparseable 3D vector: \"{0}\""),
338     UNPARSEABLE_COMPLEX_NUMBER("unparseable complex number: \"{0}\""),
339     UNPARSEABLE_REAL_VECTOR("unparseable real vector: \"{0}\""),
340     UNSUPPORTED_EXPANSION_MODE("unsupported expansion mode {0}, supported modes are {1} ({2}) and {3} ({4})"),
341     UNSUPPORTED_OPERATION("unsupported operation"), /* keep */
342     ARITHMETIC_EXCEPTION("arithmetic exception"), /* keep */
343     ILLEGAL_STATE("illegal state"), /* keep */
344     USER_EXCEPTION("exception generated in user code"), /* keep */
345     URL_CONTAINS_NO_DATA("URL {0} contains no data"),
346     VALUES_ADDED_BEFORE_CONFIGURING_STATISTIC("{0} values have been added before statistic is configured"),
347     VECTOR_LENGTH_MISMATCH("vector length mismatch: got {0} but expected {1}"),
348     VECTOR_MUST_HAVE_AT_LEAST_ONE_ELEMENT("vector must have at least one element"),
349     WEIGHT_AT_LEAST_ONE_NON_ZERO("weigth array must contain at least one non-zero value"),
350     WRONG_BLOCK_LENGTH("wrong array shape (block length = {0}, expected {1})"),
351     WRONG_NUMBER_OF_POINTS("{0} points are required, got only {1}"),
352     NUMBER_OF_POINTS("number of points ({0})"), /* keep */
353     ZERO_DENOMINATOR("denominator must be different from 0"), /* keep */
354     ZERO_DENOMINATOR_IN_FRACTION("zero denominator in fraction {0}/{1}"),
355     ZERO_FRACTION_TO_DIVIDE_BY("the fraction to divide by must not be zero: {0}/{1}"),
356     ZERO_NORM("zero norm"),
357     ZERO_NORM_FOR_ROTATION_AXIS("zero norm for rotation axis"),
358     ZERO_NORM_FOR_ROTATION_DEFINING_VECTOR("zero norm for rotation defining vector"),
359     ZERO_NOT_ALLOWED("zero not allowed here");
360 
361     // CHECKSTYLE: resume JavadocVariable
362     // CHECKSTYLE: resume MultipleVariableDeclarations
363 
364 
365     /** Source English format. */
366     private final String sourceFormat;
367 
368     /** Simple constructor.
369      * @param sourceFormat source English format to use when no
370      * localized version is available
371      */
372     private LocalizedFormats(final String sourceFormat) {
373         this.sourceFormat = sourceFormat;
374     }
375 
376     /** {@inheritDoc} */
377     public String getSourceString() {
378         return sourceFormat;
379     }
380 
381     /** {@inheritDoc} */
382     public String getLocalizedString(final Locale locale) {
383         try {
384             final String path = LocalizedFormats.class.getName().replaceAll("\\.", "/");
385             ResourceBundle bundle =
386                     ResourceBundle.getBundle("assets/" + path, locale);
387             if (bundle.getLocale().getLanguage().equals(locale.getLanguage())) {
388                 // the value of the resource is the translated format
389                 return bundle.getString(toString());
390             }
391 
392         } catch (MissingResourceException mre) { // NOPMD
393             // do nothing here
394         }
395 
396         // either the locale is not supported or the resource is unknown
397         // don't translate and fall back to using the source format
398         return sourceFormat;
399 
400     }
401 
402 }