http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/NotStrictlyPositiveException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/NotStrictlyPositiveException.java b/src/main/java/org/apache/commons/math3/exception/NotStrictlyPositiveException.java deleted file mode 100644 index b4f2bf5..0000000 --- a/src/main/java/org/apache/commons/math3/exception/NotStrictlyPositiveException.java +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.Localizable; - -/** - * Exception to be thrown when the argument is not greater than 0. - * - * @since 2.2 - */ -public class NotStrictlyPositiveException extends NumberIsTooSmallException { - - /** Serializable version Id. */ - private static final long serialVersionUID = -7824848630829852237L; - - /** - * Construct the exception. - * - * @param value Argument. - */ - public NotStrictlyPositiveException(Number value) { - super(value, INTEGER_ZERO, false); - } - /** - * Construct the exception with a specific context. - * - * @param specific Specific context where the error occurred. - * @param value Argument. - */ - public NotStrictlyPositiveException(Localizable specific, - Number value) { - super(specific, value, INTEGER_ZERO, false); - } -}
http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/NullArgumentException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/NullArgumentException.java b/src/main/java/org/apache/commons/math3/exception/NullArgumentException.java deleted file mode 100644 index d56f7e0..0000000 --- a/src/main/java/org/apache/commons/math3/exception/NullArgumentException.java +++ /dev/null @@ -1,51 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.Localizable; -import org.apache.commons.math3.exception.util.LocalizedFormats; - -/** - * All conditions checks that fail due to a {@code null} argument must throw - * this exception. - * This class is meant to signal a precondition violation ("null is an illegal - * argument") and so does not extend the standard {@code NullPointerException}. - * Propagation of {@code NullPointerException} from within Commons-Math is - * construed to be a bug. - * - * @since 2.2 - */ -public class NullArgumentException extends MathIllegalArgumentException { - /** Serializable version Id. */ - private static final long serialVersionUID = -6024911025449780478L; - - /** - * Default constructor. - */ - public NullArgumentException() { - this(LocalizedFormats.NULL_NOT_ALLOWED); - } - /** - * @param pattern Message pattern providing the specific context of - * the error. - * @param arguments Values for replacing the placeholders in {@code pattern}. - */ - public NullArgumentException(Localizable pattern, - Object ... arguments) { - super(pattern, arguments); - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/NumberIsTooLargeException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/NumberIsTooLargeException.java b/src/main/java/org/apache/commons/math3/exception/NumberIsTooLargeException.java deleted file mode 100644 index a65c5e2..0000000 --- a/src/main/java/org/apache/commons/math3/exception/NumberIsTooLargeException.java +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.Localizable; -import org.apache.commons.math3.exception.util.LocalizedFormats; - -/** - * Exception to be thrown when a number is too large. - * - * @since 2.2 - */ -public class NumberIsTooLargeException extends MathIllegalNumberException { - /** Serializable version Id. */ - private static final long serialVersionUID = 4330003017885151975L; - /** - * Higher bound. - */ - private final Number max; - /** - * Whether the maximum is included in the allowed range. - */ - private final boolean boundIsAllowed; - - /** - * Construct the exception. - * - * @param wrong Value that is larger than the maximum. - * @param max Maximum. - * @param boundIsAllowed if true the maximum is included in the allowed range. - */ - public NumberIsTooLargeException(Number wrong, - Number max, - boolean boundIsAllowed) { - this(boundIsAllowed ? - LocalizedFormats.NUMBER_TOO_LARGE : - LocalizedFormats.NUMBER_TOO_LARGE_BOUND_EXCLUDED, - wrong, max, boundIsAllowed); - } - /** - * Construct the exception with a specific context. - * - * @param specific Specific context pattern. - * @param wrong Value that is larger than the maximum. - * @param max Maximum. - * @param boundIsAllowed if true the maximum is included in the allowed range. - */ - public NumberIsTooLargeException(Localizable specific, - Number wrong, - Number max, - boolean boundIsAllowed) { - super(specific, wrong, max); - - this.max = max; - this.boundIsAllowed = boundIsAllowed; - } - - /** - * @return {@code true} if the maximum is included in the allowed range. - */ - public boolean getBoundIsAllowed() { - return boundIsAllowed; - } - - /** - * @return the maximum. - */ - public Number getMax() { - return max; - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/NumberIsTooSmallException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/NumberIsTooSmallException.java b/src/main/java/org/apache/commons/math3/exception/NumberIsTooSmallException.java deleted file mode 100644 index 5073ef8..0000000 --- a/src/main/java/org/apache/commons/math3/exception/NumberIsTooSmallException.java +++ /dev/null @@ -1,86 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.Localizable; -import org.apache.commons.math3.exception.util.LocalizedFormats; - -/** - * Exception to be thrown when a number is too small. - * - * @since 2.2 - */ -public class NumberIsTooSmallException extends MathIllegalNumberException { - /** Serializable version Id. */ - private static final long serialVersionUID = -6100997100383932834L; - /** - * Higher bound. - */ - private final Number min; - /** - * Whether the maximum is included in the allowed range. - */ - private final boolean boundIsAllowed; - - /** - * Construct the exception. - * - * @param wrong Value that is smaller than the minimum. - * @param min Minimum. - * @param boundIsAllowed Whether {@code min} is included in the allowed range. - */ - public NumberIsTooSmallException(Number wrong, - Number min, - boolean boundIsAllowed) { - this(boundIsAllowed ? - LocalizedFormats.NUMBER_TOO_SMALL : - LocalizedFormats.NUMBER_TOO_SMALL_BOUND_EXCLUDED, - wrong, min, boundIsAllowed); - } - - /** - * Construct the exception with a specific context. - * - * @param specific Specific context pattern. - * @param wrong Value that is smaller than the minimum. - * @param min Minimum. - * @param boundIsAllowed Whether {@code min} is included in the allowed range. - */ - public NumberIsTooSmallException(Localizable specific, - Number wrong, - Number min, - boolean boundIsAllowed) { - super(specific, wrong, min); - - this.min = min; - this.boundIsAllowed = boundIsAllowed; - } - - /** - * @return {@code true} if the minimum is included in the allowed range. - */ - public boolean getBoundIsAllowed() { - return boundIsAllowed; - } - - /** - * @return the minimum. - */ - public Number getMin() { - return min; - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/OutOfRangeException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/OutOfRangeException.java b/src/main/java/org/apache/commons/math3/exception/OutOfRangeException.java deleted file mode 100644 index 99079d7..0000000 --- a/src/main/java/org/apache/commons/math3/exception/OutOfRangeException.java +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.LocalizedFormats; -import org.apache.commons.math3.exception.util.Localizable; - -/** - * Exception to be thrown when some argument is out of range. - * - * @since 2.2 - */ -public class OutOfRangeException extends MathIllegalNumberException { - /** Serializable version Id. */ - private static final long serialVersionUID = 111601815794403609L; - /** Lower bound. */ - private final Number lo; - /** Higher bound. */ - private final Number hi; - - /** - * Construct an exception from the mismatched dimensions. - * - * @param wrong Requested value. - * @param lo Lower bound. - * @param hi Higher bound. - */ - public OutOfRangeException(Number wrong, - Number lo, - Number hi) { - this(LocalizedFormats.OUT_OF_RANGE_SIMPLE, wrong, lo, hi); - } - - /** - * Construct an exception from the mismatched dimensions with a - * specific context information. - * - * @param specific Context information. - * @param wrong Requested value. - * @param lo Lower bound. - * @param hi Higher bound. - */ - public OutOfRangeException(Localizable specific, - Number wrong, - Number lo, - Number hi) { - super(specific, wrong, lo, hi); - this.lo = lo; - this.hi = hi; - } - - /** - * @return the lower bound. - */ - public Number getLo() { - return lo; - } - /** - * @return the higher bound. - */ - public Number getHi() { - return hi; - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/TooManyEvaluationsException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/TooManyEvaluationsException.java b/src/main/java/org/apache/commons/math3/exception/TooManyEvaluationsException.java deleted file mode 100644 index 09da0a0..0000000 --- a/src/main/java/org/apache/commons/math3/exception/TooManyEvaluationsException.java +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.LocalizedFormats; - -/** - * Exception to be thrown when the maximal number of evaluations is exceeded. - * - * @since 3.0 - */ -public class TooManyEvaluationsException extends MaxCountExceededException { - /** Serializable version Id. */ - private static final long serialVersionUID = 4330003017885151975L; - - /** - * Construct the exception. - * - * @param max Maximum number of evaluations. - */ - public TooManyEvaluationsException(Number max) { - super(max); - getContext().addMessage(LocalizedFormats.EVALUATIONS); - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/TooManyIterationsException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/TooManyIterationsException.java b/src/main/java/org/apache/commons/math3/exception/TooManyIterationsException.java deleted file mode 100644 index c49f405..0000000 --- a/src/main/java/org/apache/commons/math3/exception/TooManyIterationsException.java +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.LocalizedFormats; - -/** - * Exception to be thrown when the maximal number of iterations is exceeded. - * - * @since 3.1 - */ -public class TooManyIterationsException extends MaxCountExceededException { - /** Serializable version Id. */ - private static final long serialVersionUID = 20121211L; - - /** - * Construct the exception. - * - * @param max Maximum number of evaluations. - */ - public TooManyIterationsException(Number max) { - super(max); - getContext().addMessage(LocalizedFormats.ITERATIONS); - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/ZeroException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/ZeroException.java b/src/main/java/org/apache/commons/math3/exception/ZeroException.java deleted file mode 100644 index 58acf79..0000000 --- a/src/main/java/org/apache/commons/math3/exception/ZeroException.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception; - -import org.apache.commons.math3.exception.util.Localizable; -import org.apache.commons.math3.exception.util.LocalizedFormats; - -/** - * Exception to be thrown when zero is provided where it is not allowed. - * - * @since 2.2 - */ -public class ZeroException extends MathIllegalNumberException { - - /** Serializable version identifier */ - private static final long serialVersionUID = -1960874856936000015L; - - /** - * Construct the exception. - */ - public ZeroException() { - this(LocalizedFormats.ZERO_NOT_ALLOWED); - } - - /** - * Construct the exception with a specific context. - * - * @param specific Specific context pattern. - * @param arguments Arguments. - */ - public ZeroException(Localizable specific, Object ... arguments) { - super(specific, INTEGER_ZERO, arguments); - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/package-info.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/package-info.java b/src/main/java/org/apache/commons/math3/exception/package-info.java deleted file mode 100644 index f6e7319..0000000 --- a/src/main/java/org/apache/commons/math3/exception/package-info.java +++ /dev/null @@ -1,23 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -/** - * - * Specialized exceptions for algorithms errors. The exceptions can be localized - * using simple java properties. - * - */ -package org.apache.commons.math3.exception; http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/util/ArgUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/util/ArgUtils.java b/src/main/java/org/apache/commons/math3/exception/util/ArgUtils.java deleted file mode 100644 index 74214cc..0000000 --- a/src/main/java/org/apache/commons/math3/exception/util/ArgUtils.java +++ /dev/null @@ -1,55 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception.util; - -import java.util.List; -import java.util.ArrayList; - -/** - * Utility class for transforming the list of arguments passed to - * constructors of exceptions. - * - */ -public class ArgUtils { - /** - * Class contains only static methods. - */ - private ArgUtils() {} - - /** - * Transform a multidimensional array into a one-dimensional list. - * - * @param array Array (possibly multidimensional). - * @return a list of all the {@code Object} instances contained in - * {@code array}. - */ - public static Object[] flatten(Object[] array) { - final List<Object> list = new ArrayList<Object>(); - if (array != null) { - for (Object o : array) { - if (o instanceof Object[]) { - for (Object oR : flatten((Object[]) o)) { - list.add(oR); - } - } else { - list.add(o); - } - } - } - return list.toArray(); - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/util/DummyLocalizable.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/util/DummyLocalizable.java b/src/main/java/org/apache/commons/math3/exception/util/DummyLocalizable.java deleted file mode 100644 index cd56708..0000000 --- a/src/main/java/org/apache/commons/math3/exception/util/DummyLocalizable.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception.util; - -import java.util.Locale; - -/** - * Dummy implementation of the {@link Localizable} interface, without localization. - * - * @since 2.2 - */ -public class DummyLocalizable implements Localizable { - - /** Serializable version identifier. */ - private static final long serialVersionUID = 8843275624471387299L; - - /** Source string. */ - private final String source; - - /** Simple constructor. - * @param source source text - */ - public DummyLocalizable(final String source) { - this.source = source; - } - - /** {@inheritDoc} */ - public String getSourceString() { - return source; - } - - /** {@inheritDoc} */ - public String getLocalizedString(Locale locale) { - return source; - } - - /** {@inheritDoc} */ - @Override - public String toString() { - return source; - } - -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/util/ExceptionContext.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/util/ExceptionContext.java b/src/main/java/org/apache/commons/math3/exception/util/ExceptionContext.java deleted file mode 100644 index a9fd95c..0000000 --- a/src/main/java/org/apache/commons/math3/exception/util/ExceptionContext.java +++ /dev/null @@ -1,334 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception.util; - -import java.util.List; -import java.util.ArrayList; -import java.util.Set; -import java.util.Map; -import java.io.IOException; -import java.io.Serializable; -import java.io.ObjectOutputStream; -import java.io.ObjectInputStream; -import java.util.HashMap; -import java.text.MessageFormat; -import java.util.Locale; - -/** - * Class that contains the actual implementation of the functionality mandated - * by the {@link ExceptionContext} interface. - * All Commons Math exceptions delegate the interface's methods to this class. - * - * @since 3.0 - */ -public class ExceptionContext implements Serializable { - /** Serializable version Id. */ - private static final long serialVersionUID = -6024911025449780478L; - /** - * The throwable to which this context refers to. - */ - private Throwable throwable; - /** - * Various informations that enrich the informative message. - */ - private List<Localizable> msgPatterns; - /** - * Various informations that enrich the informative message. - * The arguments will replace the corresponding place-holders in - * {@link #msgPatterns}. - */ - private List<Object[]> msgArguments; - /** - * Arbitrary context information. - */ - private Map<String, Object> context; - - /** Simple constructor. - * @param throwable the exception this context refers too - */ - public ExceptionContext(final Throwable throwable) { - this.throwable = throwable; - msgPatterns = new ArrayList<Localizable>(); - msgArguments = new ArrayList<Object[]>(); - context = new HashMap<String, Object>(); - } - - /** Get a reference to the exception to which the context relates. - * @return a reference to the exception to which the context relates - */ - public Throwable getThrowable() { - return throwable; - } - - /** - * Adds a message. - * - * @param pattern Message pattern. - * @param arguments Values for replacing the placeholders in the message - * pattern. - */ - public void addMessage(Localizable pattern, - Object ... arguments) { - msgPatterns.add(pattern); - msgArguments.add(ArgUtils.flatten(arguments)); - } - - /** - * Sets the context (key, value) pair. - * Keys are assumed to be unique within an instance. If the same key is - * assigned a new value, the previous one will be lost. - * - * @param key Context key (not null). - * @param value Context value. - */ - public void setValue(String key, Object value) { - context.put(key, value); - } - - /** - * Gets the value associated to the given context key. - * - * @param key Context key. - * @return the context value or {@code null} if the key does not exist. - */ - public Object getValue(String key) { - return context.get(key); - } - - /** - * Gets all the keys stored in the exception - * - * @return the set of keys. - */ - public Set<String> getKeys() { - return context.keySet(); - } - - /** - * Gets the default message. - * - * @return the message. - */ - public String getMessage() { - return getMessage(Locale.US); - } - - /** - * Gets the message in the default locale. - * - * @return the localized message. - */ - public String getLocalizedMessage() { - return getMessage(Locale.getDefault()); - } - - /** - * Gets the message in a specified locale. - * - * @param locale Locale in which the message should be translated. - * @return the localized message. - */ - public String getMessage(final Locale locale) { - return buildMessage(locale, ": "); - } - - /** - * Gets the message in a specified locale. - * - * @param locale Locale in which the message should be translated. - * @param separator Separator inserted between the message parts. - * @return the localized message. - */ - public String getMessage(final Locale locale, - final String separator) { - return buildMessage(locale, separator); - } - - /** - * Builds a message string. - * - * @param locale Locale in which the message should be translated. - * @param separator Message separator. - * @return a localized message string. - */ - private String buildMessage(Locale locale, - String separator) { - final StringBuilder sb = new StringBuilder(); - int count = 0; - final int len = msgPatterns.size(); - for (int i = 0; i < len; i++) { - final Localizable pat = msgPatterns.get(i); - final Object[] args = msgArguments.get(i); - final MessageFormat fmt = new MessageFormat(pat.getLocalizedString(locale), - locale); - sb.append(fmt.format(args)); - if (++count < len) { - // Add a separator if there are other messages. - sb.append(separator); - } - } - - return sb.toString(); - } - - /** - * Serialize this object to the given stream. - * - * @param out Stream. - * @throws IOException This should never happen. - */ - private void writeObject(ObjectOutputStream out) - throws IOException { - out.writeObject(throwable); - serializeMessages(out); - serializeContext(out); - } - /** - * Deserialize this object from the given stream. - * - * @param in Stream. - * @throws IOException This should never happen. - * @throws ClassNotFoundException This should never happen. - */ - private void readObject(ObjectInputStream in) - throws IOException, - ClassNotFoundException { - throwable = (Throwable) in.readObject(); - deSerializeMessages(in); - deSerializeContext(in); - } - - /** - * Serialize {@link #msgPatterns} and {@link #msgArguments}. - * - * @param out Stream. - * @throws IOException This should never happen. - */ - private void serializeMessages(ObjectOutputStream out) - throws IOException { - // Step 1. - final int len = msgPatterns.size(); - out.writeInt(len); - // Step 2. - for (int i = 0; i < len; i++) { - final Localizable pat = msgPatterns.get(i); - // Step 3. - out.writeObject(pat); - final Object[] args = msgArguments.get(i); - final int aLen = args.length; - // Step 4. - out.writeInt(aLen); - for (int j = 0; j < aLen; j++) { - if (args[j] instanceof Serializable) { - // Step 5a. - out.writeObject(args[j]); - } else { - // Step 5b. - out.writeObject(nonSerializableReplacement(args[j])); - } - } - } - } - - /** - * Deserialize {@link #msgPatterns} and {@link #msgArguments}. - * - * @param in Stream. - * @throws IOException This should never happen. - * @throws ClassNotFoundException This should never happen. - */ - private void deSerializeMessages(ObjectInputStream in) - throws IOException, - ClassNotFoundException { - // Step 1. - final int len = in.readInt(); - msgPatterns = new ArrayList<Localizable>(len); - msgArguments = new ArrayList<Object[]>(len); - // Step 2. - for (int i = 0; i < len; i++) { - // Step 3. - final Localizable pat = (Localizable) in.readObject(); - msgPatterns.add(pat); - // Step 4. - final int aLen = in.readInt(); - final Object[] args = new Object[aLen]; - for (int j = 0; j < aLen; j++) { - // Step 5. - args[j] = in.readObject(); - } - msgArguments.add(args); - } - } - - /** - * Serialize {@link #context}. - * - * @param out Stream. - * @throws IOException This should never happen. - */ - private void serializeContext(ObjectOutputStream out) - throws IOException { - // Step 1. - final int len = context.keySet().size(); - out.writeInt(len); - for (String key : context.keySet()) { - // Step 2. - out.writeObject(key); - final Object value = context.get(key); - if (value instanceof Serializable) { - // Step 3a. - out.writeObject(value); - } else { - // Step 3b. - out.writeObject(nonSerializableReplacement(value)); - } - } - } - - /** - * Deserialize {@link #context}. - * - * @param in Stream. - * @throws IOException This should never happen. - * @throws ClassNotFoundException This should never happen. - */ - private void deSerializeContext(ObjectInputStream in) - throws IOException, - ClassNotFoundException { - // Step 1. - final int len = in.readInt(); - context = new HashMap<String, Object>(); - for (int i = 0; i < len; i++) { - // Step 2. - final String key = (String) in.readObject(); - // Step 3. - final Object value = in.readObject(); - context.put(key, value); - } - } - - /** - * Replaces a non-serializable object with an error message string. - * - * @param obj Object that does not implement the {@code Serializable} - * interface. - * @return a string that mentions which class could not be serialized. - */ - private String nonSerializableReplacement(Object obj) { - return "[Object could not be serialized: " + obj.getClass().getName() + "]"; - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/util/ExceptionContextProvider.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/util/ExceptionContextProvider.java b/src/main/java/org/apache/commons/math3/exception/util/ExceptionContextProvider.java deleted file mode 100644 index 913f66a..0000000 --- a/src/main/java/org/apache/commons/math3/exception/util/ExceptionContextProvider.java +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception.util; - -/** - * Interface for accessing the context data structure stored in Commons Math - * exceptions. - * - */ -public interface ExceptionContextProvider { - /** - * Gets a reference to the "rich context" data structure that allows to - * customize error messages and store key, value pairs in exceptions. - * - * @return a reference to the exception context. - */ - ExceptionContext getContext(); - -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/util/Localizable.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/util/Localizable.java b/src/main/java/org/apache/commons/math3/exception/util/Localizable.java deleted file mode 100644 index 9758bc2..0000000 --- a/src/main/java/org/apache/commons/math3/exception/util/Localizable.java +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception.util; - -import java.io.Serializable; -import java.util.Locale; - -/** - * Interface for localizable strings. - * - * @since 2.2 - */ -public interface Localizable extends Serializable { - /** - * Gets the source (non-localized) string. - * - * @return the source string. - */ - String getSourceString(); - - /** - * Gets the localized string. - * - * @param locale locale into which to get the string. - * @return the localized string or the source string if no - * localized version is available. - */ - String getLocalizedString(Locale locale); -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/util/LocalizedFormats.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/util/LocalizedFormats.java b/src/main/java/org/apache/commons/math3/exception/util/LocalizedFormats.java deleted file mode 100644 index 0f3848f..0000000 --- a/src/main/java/org/apache/commons/math3/exception/util/LocalizedFormats.java +++ /dev/null @@ -1,408 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.exception.util; - -import java.util.Locale; -import java.util.MissingResourceException; -import java.util.ResourceBundle; - -/** - * Enumeration for localized messages formats used in exceptions messages. - * <p> - * The constants in this enumeration represent the available - * formats as localized strings. These formats are intended to be - * localized using simple properties files, using the constant - * name as the key and the property value as the message format. - * The source English format is provided in the constants themselves - * to serve both as a reminder for developers to understand the parameters - * needed by each format, as a basis for translators to create - * localized properties files, and as a default format if some - * translation is missing. - * </p> - * @since 2.2 - */ -public enum LocalizedFormats implements Localizable { - - // CHECKSTYLE: stop MultipleVariableDeclarations - // CHECKSTYLE: stop JavadocVariable - - ARGUMENT_OUTSIDE_DOMAIN("Argument {0} outside domain [{1} ; {2}]"), - ARRAY_SIZE_EXCEEDS_MAX_VARIABLES("array size cannot be greater than {0}"), - ARRAY_SIZES_SHOULD_HAVE_DIFFERENCE_1("array sizes should have difference 1 ({0} != {1} + 1)"), - ARRAY_SUMS_TO_ZERO("array sums to zero"), - ASSYMETRIC_EIGEN_NOT_SUPPORTED("eigen decomposition of assymetric matrices not supported yet"), - AT_LEAST_ONE_COLUMN("matrix must have at least one column"), - AT_LEAST_ONE_ROW("matrix must have at least one row"), - BANDWIDTH("bandwidth ({0})"), - BESSEL_FUNCTION_BAD_ARGUMENT("Bessel function of order {0} cannot be computed for x = {1}"), - BESSEL_FUNCTION_FAILED_CONVERGENCE("Bessel function of order {0} failed to converge for x = {1}"), - BINOMIAL_INVALID_PARAMETERS_ORDER("must have n >= k for binomial coefficient (n, k), got k = {0}, n = {1}"), - BINOMIAL_NEGATIVE_PARAMETER("must have n >= 0 for binomial coefficient (n, k), got n = {0}"), - CANNOT_CLEAR_STATISTIC_CONSTRUCTED_FROM_EXTERNAL_MOMENTS("statistics constructed from external moments cannot be cleared"), - CANNOT_COMPUTE_0TH_ROOT_OF_UNITY("cannot compute 0-th root of unity, indefinite result"), - CANNOT_COMPUTE_BETA_DENSITY_AT_0_FOR_SOME_ALPHA("cannot compute beta density at 0 when alpha = {0,number}"), - CANNOT_COMPUTE_BETA_DENSITY_AT_1_FOR_SOME_BETA("cannot compute beta density at 1 when beta = %.3g"), - CANNOT_COMPUTE_NTH_ROOT_FOR_NEGATIVE_N("cannot compute nth root for null or negative n: {0}"), - CANNOT_DISCARD_NEGATIVE_NUMBER_OF_ELEMENTS("cannot discard a negative number of elements ({0})"), - CANNOT_FORMAT_INSTANCE_AS_3D_VECTOR("cannot format a {0} instance as a 3D vector"), - CANNOT_FORMAT_INSTANCE_AS_COMPLEX("cannot format a {0} instance as a complex number"), - CANNOT_FORMAT_INSTANCE_AS_REAL_VECTOR("cannot format a {0} instance as a real vector"), - CANNOT_FORMAT_OBJECT_TO_FRACTION("cannot format given object as a fraction number"), - CANNOT_INCREMENT_STATISTIC_CONSTRUCTED_FROM_EXTERNAL_MOMENTS("statistics constructed from external moments cannot be incremented"), - CANNOT_NORMALIZE_A_ZERO_NORM_VECTOR("cannot normalize a zero norm vector"), - CANNOT_RETRIEVE_AT_NEGATIVE_INDEX("elements cannot be retrieved from a negative array index {0}"), - CANNOT_SET_AT_NEGATIVE_INDEX("cannot set an element at a negative index {0}"), - CANNOT_SUBSTITUTE_ELEMENT_FROM_EMPTY_ARRAY("cannot substitute an element from an empty array"), - CANNOT_TRANSFORM_TO_DOUBLE("Conversion Exception in Transformation: {0}"), - CARDAN_ANGLES_SINGULARITY("Cardan angles singularity"), - CLASS_DOESNT_IMPLEMENT_COMPARABLE("class ({0}) does not implement Comparable"), - CLOSEST_ORTHOGONAL_MATRIX_HAS_NEGATIVE_DETERMINANT("the closest orthogonal matrix has a negative determinant {0}"), - COLUMN_INDEX_OUT_OF_RANGE("column index {0} out of allowed range [{1}, {2}]"), - COLUMN_INDEX("column index ({0})"), /* keep */ - CONSTRAINT("constraint"), /* keep */ - CONTINUED_FRACTION_INFINITY_DIVERGENCE("Continued fraction convergents diverged to +/- infinity for value {0}"), - CONTINUED_FRACTION_NAN_DIVERGENCE("Continued fraction diverged to NaN for value {0}"), - 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."), - 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."), - CONVERGENCE_FAILED("convergence failed"), /* keep */ - CROSSING_BOUNDARY_LOOPS("some outline boundary loops cross each other"), - CROSSOVER_RATE("crossover rate ({0})"), - CUMULATIVE_PROBABILITY_RETURNED_NAN("Cumulative probability function returned NaN for argument {0} p = {1}"), - DIFFERENT_ROWS_LENGTHS("some rows have length {0} while others have length {1}"), - DIFFERENT_ORIG_AND_PERMUTED_DATA("original and permuted data must contain the same elements"), - DIGEST_NOT_INITIALIZED("digest not initialized"), - DIMENSIONS_MISMATCH_2x2("got {0}x{1} but expected {2}x{3}"), /* keep */ - DIMENSIONS_MISMATCH_SIMPLE("{0} != {1}"), /* keep */ - DIMENSIONS_MISMATCH("dimensions mismatch"), /* keep */ - DISCRETE_CUMULATIVE_PROBABILITY_RETURNED_NAN("Discrete cumulative probability function returned NaN for argument {0}"), - DISTRIBUTION_NOT_LOADED("distribution not loaded"), - DUPLICATED_ABSCISSA_DIVISION_BY_ZERO("duplicated abscissa {0} causes division by zero"), - ELITISM_RATE("elitism rate ({0})"), - EMPTY_CLUSTER_IN_K_MEANS("empty cluster in k-means"), - EMPTY_INTERPOLATION_SAMPLE("sample for interpolation is empty"), - EMPTY_POLYNOMIALS_COEFFICIENTS_ARRAY("empty polynomials coefficients array"), /* keep */ - EMPTY_SELECTED_COLUMN_INDEX_ARRAY("empty selected column index array"), - EMPTY_SELECTED_ROW_INDEX_ARRAY("empty selected row index array"), - EMPTY_STRING_FOR_IMAGINARY_CHARACTER("empty string for imaginary character"), - ENDPOINTS_NOT_AN_INTERVAL("endpoints do not specify an interval: [{0}, {1}]"), - EQUAL_VERTICES_IN_SIMPLEX("equal vertices {0} and {1} in simplex configuration"), - EULER_ANGLES_SINGULARITY("Euler angles singularity"), - EVALUATION("evaluation"), /* keep */ - EXPANSION_FACTOR_SMALLER_THAN_ONE("expansion factor smaller than one ({0})"), - FACTORIAL_NEGATIVE_PARAMETER("must have n >= 0 for n!, got n = {0}"), - 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}"), - FAILED_FRACTION_CONVERSION("Unable to convert {0} to fraction after {1} iterations"), - FIRST_COLUMNS_NOT_INITIALIZED_YET("first {0} columns are not initialized yet"), - FIRST_ELEMENT_NOT_ZERO("first element is not 0: {0}"), - FIRST_ROWS_NOT_INITIALIZED_YET("first {0} rows are not initialized yet"), - FRACTION_CONVERSION_OVERFLOW("Overflow trying to convert {0} to fraction ({1}/{2})"), - FUNCTION_NOT_DIFFERENTIABLE("function is not differentiable"), - FUNCTION_NOT_POLYNOMIAL("function is not polynomial"), - GCD_OVERFLOW_32_BITS("overflow: gcd({0}, {1}) is 2^31"), - GCD_OVERFLOW_64_BITS("overflow: gcd({0}, {1}) is 2^63"), - HOLE_BETWEEN_MODELS_TIME_RANGES("{0} wide hole between models time ranges"), - ILL_CONDITIONED_OPERATOR("condition number {1} is too high "), - INCONSISTENT_STATE_AT_2_PI_WRAPPING("inconsistent state at 2\u03c0 wrapping"), - INDEX_LARGER_THAN_MAX("the index specified: {0} is larger than the current maximal index {1}"), - INDEX_NOT_POSITIVE("index ({0}) is not positive"), - INDEX_OUT_OF_RANGE("index {0} out of allowed range [{1}, {2}]"), - INDEX("index ({0})"), /* keep */ - NOT_FINITE_NUMBER("{0} is not a finite number"), /* keep */ - INFINITE_BOUND("interval bounds must be finite"), - ARRAY_ELEMENT("value {0} at index {1}"), /* keep */ - INFINITE_ARRAY_ELEMENT("Array contains an infinite element, {0} at index {1}"), - INFINITE_VALUE_CONVERSION("cannot convert infinite value"), - INITIAL_CAPACITY_NOT_POSITIVE("initial capacity ({0}) is not positive"), - INITIAL_COLUMN_AFTER_FINAL_COLUMN("initial column {1} after final column {0}"), - INITIAL_ROW_AFTER_FINAL_ROW("initial row {1} after final row {0}"), - @Deprecated - INPUT_DATA_FROM_UNSUPPORTED_DATASOURCE("input data comes from unsupported datasource: {0}, supported sources: {1}, {2}"), - INSTANCES_NOT_COMPARABLE_TO_EXISTING_VALUES("instance of class {0} not comparable to existing values"), - INSUFFICIENT_DATA("insufficient data"), - INSUFFICIENT_DATA_FOR_T_STATISTIC("insufficient data for t statistic, needs at least 2, got {0}"), - INSUFFICIENT_DIMENSION("insufficient dimension {0}, must be at least {1}"), - DIMENSION("dimension ({0})"), /* keep */ - INSUFFICIENT_OBSERVED_POINTS_IN_SAMPLE("sample contains {0} observed points, at least {1} are required"), - INSUFFICIENT_ROWS_AND_COLUMNS("insufficient data: only {0} rows and {1} columns."), - INTEGRATION_METHOD_NEEDS_AT_LEAST_TWO_PREVIOUS_POINTS("multistep method needs at least {0} previous steps, got {1}"), - INTERNAL_ERROR("internal error, please fill a bug report at {0}"), - INVALID_BINARY_DIGIT("invalid binary digit: {0}"), - INVALID_BINARY_CHROMOSOME("binary mutation works on BinaryChromosome only"), - INVALID_BRACKETING_PARAMETERS("invalid bracketing parameters: lower bound={0}, initial={1}, upper bound={2}"), - INVALID_FIXED_LENGTH_CHROMOSOME("one-point crossover only works with fixed-length chromosomes"), - INVALID_IMPLEMENTATION("required functionality is missing in {0}"), - INVALID_INTERVAL_INITIAL_VALUE_PARAMETERS("invalid interval, initial value parameters: lower={0}, initial={1}, upper={2}"), - INVALID_ITERATIONS_LIMITS("invalid iteration limits: min={0}, max={1}"), - INVALID_MAX_ITERATIONS("bad value for maximum iterations number: {0}"), - NOT_ENOUGH_DATA_REGRESSION("the number of observations is not sufficient to conduct regression"), - INVALID_REGRESSION_ARRAY("input data array length = {0} does not match the number of observations = {1} and the number of regressors = {2}"), - INVALID_REGRESSION_OBSERVATION("length of regressor array = {0} does not match the number of variables = {1} in the model"), - 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})"), - ITERATOR_EXHAUSTED("iterator exhausted"), - ITERATIONS("iterations"), /* keep */ - LCM_OVERFLOW_32_BITS("overflow: lcm({0}, {1}) is 2^31"), - LCM_OVERFLOW_64_BITS("overflow: lcm({0}, {1}) is 2^63"), - LIST_OF_CHROMOSOMES_BIGGER_THAN_POPULATION_SIZE("list of chromosomes bigger than maxPopulationSize"), - LOESS_EXPECTS_AT_LEAST_ONE_POINT("Loess expects at least 1 point"), - LOWER_BOUND_NOT_BELOW_UPPER_BOUND("lower bound ({0}) must be strictly less than upper bound ({1})"), /* keep */ - LOWER_ENDPOINT_ABOVE_UPPER_ENDPOINT("lower endpoint ({0}) must be less than or equal to upper endpoint ({1})"), - MAP_MODIFIED_WHILE_ITERATING("map has been modified while iterating"), - EVALUATIONS("evaluations"), /* keep */ - MAX_COUNT_EXCEEDED("maximal count ({0}) exceeded"), /* keep */ - MAX_ITERATIONS_EXCEEDED("maximal number of iterations ({0}) exceeded"), - MINIMAL_STEPSIZE_REACHED_DURING_INTEGRATION("minimal step size ({1,number,0.00E00}) reached, integration needs {0,number,0.00E00}"), - 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"), - MUTATION_RATE("mutation rate ({0})"), - NAN_ELEMENT_AT_INDEX("element {0} is NaN"), - NAN_VALUE_CONVERSION("cannot convert NaN value"), - NEGATIVE_BRIGHTNESS_EXPONENT("brightness exponent should be positive or null, but got {0}"), - NEGATIVE_COMPLEX_MODULE("negative complex module {0}"), - NEGATIVE_ELEMENT_AT_2D_INDEX("element ({0}, {1}) is negative: {2}"), - NEGATIVE_ELEMENT_AT_INDEX("element {0} is negative: {1}"), - NEGATIVE_NUMBER_OF_SUCCESSES("number of successes must be non-negative ({0})"), - NUMBER_OF_SUCCESSES("number of successes ({0})"), /* keep */ - NEGATIVE_NUMBER_OF_TRIALS("number of trials must be non-negative ({0})"), - NUMBER_OF_INTERPOLATION_POINTS("number of interpolation points ({0})"), /* keep */ - NUMBER_OF_TRIALS("number of trials ({0})"), - NOT_CONVEX("vertices do not form a convex hull in CCW winding"), - ROBUSTNESS_ITERATIONS("number of robustness iterations ({0})"), - START_POSITION("start position ({0})"), /* keep */ - NON_CONVERGENT_CONTINUED_FRACTION("Continued fraction convergents failed to converge (in less than {0} iterations) for value {1}"), - NON_INVERTIBLE_TRANSFORM("non-invertible affine transform collapses some lines into single points"), - NON_POSITIVE_MICROSPHERE_ELEMENTS("number of microsphere elements must be positive, but got {0}"), - NON_POSITIVE_POLYNOMIAL_DEGREE("polynomial degree must be positive: degree={0}"), - NON_REAL_FINITE_ABSCISSA("all abscissae must be finite real numbers, but {0}-th is {1}"), - NON_REAL_FINITE_ORDINATE("all ordinatae must be finite real numbers, but {0}-th is {1}"), - NON_REAL_FINITE_WEIGHT("all weights must be finite real numbers, but {0}-th is {1}"), - NON_SQUARE_MATRIX("non square ({0}x{1}) matrix"), - NORM("Norm ({0})"), /* keep */ - NORMALIZE_INFINITE("Cannot normalize to an infinite value"), - NORMALIZE_NAN("Cannot normalize to NaN"), - NOT_ADDITION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not addition compatible"), - NOT_DECREASING_NUMBER_OF_POINTS("points {0} and {1} are not decreasing ({2} < {3})"), - NOT_DECREASING_SEQUENCE("points {3} and {2} are not decreasing ({1} < {0})"), /* keep */ - NOT_ENOUGH_DATA_FOR_NUMBER_OF_PREDICTORS("not enough data ({0} rows) for this many predictors ({1} predictors)"), - NOT_ENOUGH_POINTS_IN_SPLINE_PARTITION("spline partition must have at least {0} points, got {1}"), - NOT_INCREASING_NUMBER_OF_POINTS("points {0} and {1} are not increasing ({2} > {3})"), - NOT_INCREASING_SEQUENCE("points {3} and {2} are not increasing ({1} > {0})"), /* keep */ - NOT_MULTIPLICATION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not multiplication compatible"), - NOT_POSITIVE_DEFINITE_MATRIX("not positive definite matrix"), /* keep */ - NON_POSITIVE_DEFINITE_MATRIX("not positive definite matrix: diagonal element at ({1},{1}) is smaller than {2} ({0})"), - NON_POSITIVE_DEFINITE_OPERATOR("non positive definite linear operator"), /* keep */ - NON_SELF_ADJOINT_OPERATOR("non self-adjoint linear operator"), /* keep */ - NON_SQUARE_OPERATOR("non square ({0}x{1}) linear operator"), /* keep */ - DEGREES_OF_FREEDOM("degrees of freedom ({0})"), /* keep */ - NOT_POSITIVE_DEGREES_OF_FREEDOM("degrees of freedom must be positive ({0})"), - NOT_POSITIVE_ELEMENT_AT_INDEX("element {0} is not positive: {1}"), - NOT_POSITIVE_EXPONENT("invalid exponent {0} (must be positive)"), - NUMBER_OF_ELEMENTS_SHOULD_BE_POSITIVE("number of elements should be positive ({0})"), - BASE("base ({0})"), /* keep */ - EXPONENT("exponent ({0})"), /* keep */ - NOT_POSITIVE_LENGTH("length must be positive ({0})"), - LENGTH("length ({0})"), /* keep */ - NOT_POSITIVE_MEAN("mean must be positive ({0})"), - MEAN("mean ({0})"), /* keep */ - NOT_POSITIVE_NUMBER_OF_SAMPLES("number of sample is not positive: {0}"), - NUMBER_OF_SAMPLES("number of samples ({0})"), /* keep */ - NOT_POSITIVE_PERMUTATION("permutation k ({0}) must be positive"), - PERMUTATION_SIZE("permutation size ({0}"), /* keep */ - NOT_POSITIVE_POISSON_MEAN("the Poisson mean must be positive ({0})"), - NOT_POSITIVE_POPULATION_SIZE("population size must be positive ({0})"), - POPULATION_SIZE("population size ({0})"), /* keep */ - NOT_POSITIVE_ROW_DIMENSION("invalid row dimension: {0} (must be positive)"), - NOT_POSITIVE_SAMPLE_SIZE("sample size must be positive ({0})"), - NOT_POSITIVE_SCALE("scale must be positive ({0})"), - SCALE("scale ({0})"), /* keep */ - NOT_POSITIVE_SHAPE("shape must be positive ({0})"), - SHAPE("shape ({0})"), /* keep */ - NOT_POSITIVE_STANDARD_DEVIATION("standard deviation must be positive ({0})"), - STANDARD_DEVIATION("standard deviation ({0})"), /* keep */ - NOT_POSITIVE_UPPER_BOUND("upper bound must be positive ({0})"), - NOT_POSITIVE_WINDOW_SIZE("window size must be positive ({0})"), - NOT_POWER_OF_TWO("{0} is not a power of 2"), - NOT_POWER_OF_TWO_CONSIDER_PADDING("{0} is not a power of 2, consider padding for fix"), - NOT_POWER_OF_TWO_PLUS_ONE("{0} is not a power of 2 plus one"), - NOT_STRICTLY_DECREASING_NUMBER_OF_POINTS("points {0} and {1} are not strictly decreasing ({2} <= {3})"), - NOT_STRICTLY_DECREASING_SEQUENCE("points {3} and {2} are not strictly decreasing ({1} <= {0})"), /* keep */ - NOT_STRICTLY_INCREASING_KNOT_VALUES("knot values must be strictly increasing"), - NOT_STRICTLY_INCREASING_NUMBER_OF_POINTS("points {0} and {1} are not strictly increasing ({2} >= {3})"), - NOT_STRICTLY_INCREASING_SEQUENCE("points {3} and {2} are not strictly increasing ({1} >= {0})"), /* keep */ - NOT_SUBTRACTION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not subtraction compatible"), - NOT_SUPPORTED_IN_DIMENSION_N("method not supported in dimension {0}"), - NOT_SYMMETRIC_MATRIX("not symmetric matrix"), - NON_SYMMETRIC_MATRIX("non symmetric matrix: the difference between entries at ({0},{1}) and ({1},{0}) is larger than {2}"), /* keep */ - NO_BIN_SELECTED("no bin selected"), - NO_CONVERGENCE_WITH_ANY_START_POINT("none of the {0} start points lead to convergence"), /* keep */ - NO_DATA("no data"), /* keep */ - NO_DEGREES_OF_FREEDOM("no degrees of freedom ({0} measurements, {1} parameters)"), - NO_DENSITY_FOR_THIS_DISTRIBUTION("This distribution does not have a density function implemented"), - NO_FEASIBLE_SOLUTION("no feasible solution"), - NO_OPTIMUM_COMPUTED_YET("no optimum computed yet"), /* keep */ - NO_REGRESSORS("Regression model must include at least one regressor"), - NO_RESULT_AVAILABLE("no result available"), - NO_SUCH_MATRIX_ENTRY("no entry at indices ({0}, {1}) in a {2}x{3} matrix"), - NAN_NOT_ALLOWED("NaN is not allowed"), - NULL_NOT_ALLOWED("null is not allowed"), /* keep */ - ARRAY_ZERO_LENGTH_OR_NULL_NOT_ALLOWED("a null or zero length array not allowed"), - COVARIANCE_MATRIX("covariance matrix"), /* keep */ - DENOMINATOR("denominator"), /* keep */ - DENOMINATOR_FORMAT("denominator format"), /* keep */ - FRACTION("fraction"), /* keep */ - FUNCTION("function"), /* keep */ - IMAGINARY_FORMAT("imaginary format"), /* keep */ - INPUT_ARRAY("input array"), /* keep */ - NUMERATOR("numerator"), /* keep */ - NUMERATOR_FORMAT("numerator format"), /* keep */ - OBJECT_TRANSFORMATION("conversion exception in transformation"), /* keep */ - REAL_FORMAT("real format"), /* keep */ - WHOLE_FORMAT("whole format"), /* keep */ - NUMBER_TOO_LARGE("{0} is larger than the maximum ({1})"), /* keep */ - NUMBER_TOO_SMALL("{0} is smaller than the minimum ({1})"), /* keep */ - NUMBER_TOO_LARGE_BOUND_EXCLUDED("{0} is larger than, or equal to, the maximum ({1})"), /* keep */ - NUMBER_TOO_SMALL_BOUND_EXCLUDED("{0} is smaller than, or equal to, the minimum ({1})"), /* keep */ - NUMBER_OF_SUCCESS_LARGER_THAN_POPULATION_SIZE("number of successes ({0}) must be less than or equal to population size ({1})"), - NUMERATOR_OVERFLOW_AFTER_MULTIPLY("overflow, numerator too large after multiply: {0}"), - N_POINTS_GAUSS_LEGENDRE_INTEGRATOR_NOT_SUPPORTED("{0} points Legendre-Gauss integrator not supported, number of points must be in the {1}-{2} range"), - OBSERVED_COUNTS_ALL_ZERO("observed counts are all 0 in observed array {0}"), - OBSERVED_COUNTS_BOTTH_ZERO_FOR_ENTRY("observed counts are both zero for entry {0}"), - BOBYQA_BOUND_DIFFERENCE_CONDITION("the difference between the upper and lower bound must be larger than twice the initial trust region radius ({0})"), - OUT_OF_BOUNDS_QUANTILE_VALUE("out of bounds quantile value: {0}, must be in (0, 100]"), - OUT_OF_BOUNDS_CONFIDENCE_LEVEL("out of bounds confidence level {0}, must be between {1} and {2}"), - OUT_OF_BOUND_SIGNIFICANCE_LEVEL("out of bounds significance level {0}, must be between {1} and {2}"), - SIGNIFICANCE_LEVEL("significance level ({0})"), /* keep */ - 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}"), - OUT_OF_RANGE_ROOT_OF_UNITY_INDEX("out of range root of unity index {0} (must be in [{1};{2}])"), - OUT_OF_RANGE("out of range"), /* keep */ - OUT_OF_RANGE_SIMPLE("{0} out of [{1}, {2}] range"), /* keep */ - OUT_OF_RANGE_LEFT("{0} out of ({1}, {2}] range"), - OUT_OF_RANGE_RIGHT("{0} out of [{1}, {2}) range"), - OUTLINE_BOUNDARY_LOOP_OPEN("an outline boundary loop is open"), - OVERFLOW("overflow"), /* keep */ - OVERFLOW_IN_FRACTION("overflow in fraction {0}/{1}, cannot negate"), - OVERFLOW_IN_ADDITION("overflow in addition: {0} + {1}"), - OVERFLOW_IN_SUBTRACTION("overflow in subtraction: {0} - {1}"), - OVERFLOW_IN_MULTIPLICATION("overflow in multiplication: {0} * {1}"), - PERCENTILE_IMPLEMENTATION_CANNOT_ACCESS_METHOD("cannot access {0} method in percentile implementation {1}"), - PERCENTILE_IMPLEMENTATION_UNSUPPORTED_METHOD("percentile implementation {0} does not support {1}"), - PERMUTATION_EXCEEDS_N("permutation size ({0}) exceeds permuation domain ({1})"), /* keep */ - POLYNOMIAL("polynomial"), /* keep */ - POLYNOMIAL_INTERPOLANTS_MISMATCH_SEGMENTS("number of polynomial interpolants must match the number of segments ({0} != {1} - 1)"), - POPULATION_LIMIT_NOT_POSITIVE("population limit has to be positive"), - POWER_NEGATIVE_PARAMETERS("cannot raise an integral value to a negative power ({0}^{1})"), - PROPAGATION_DIRECTION_MISMATCH("propagation direction mismatch"), - RANDOMKEY_MUTATION_WRONG_CLASS("RandomKeyMutation works only with RandomKeys, not {0}"), - ROOTS_OF_UNITY_NOT_COMPUTED_YET("roots of unity have not been computed yet"), - ROTATION_MATRIX_DIMENSIONS("a {0}x{1} matrix cannot be a rotation matrix"), - ROW_INDEX_OUT_OF_RANGE("row index {0} out of allowed range [{1}, {2}]"), - ROW_INDEX("row index ({0})"), /* keep */ - SAME_SIGN_AT_ENDPOINTS("function values at endpoints do not have different signs, endpoints: [{0}, {1}], values: [{2}, {3}]"), - SAMPLE_SIZE_EXCEEDS_COLLECTION_SIZE("sample size ({0}) exceeds collection size ({1})"), /* keep */ - SAMPLE_SIZE_LARGER_THAN_POPULATION_SIZE("sample size ({0}) must be less than or equal to population size ({1})"), - SIMPLEX_NEED_ONE_POINT("simplex must contain at least one point"), - SIMPLE_MESSAGE("{0}"), - SINGULAR_MATRIX("matrix is singular"), /* keep */ - SINGULAR_OPERATOR("operator is singular"), - SUBARRAY_ENDS_AFTER_ARRAY_END("subarray ends after array end"), - TOO_LARGE_CUTOFF_SINGULAR_VALUE("cutoff singular value is {0}, should be at most {1}"), - TOO_LARGE_TOURNAMENT_ARITY("tournament arity ({0}) cannot be bigger than population size ({1})"), - TOO_MANY_ELEMENTS_TO_DISCARD_FROM_ARRAY("cannot discard {0} elements from a {1} elements array"), - TOO_MANY_REGRESSORS("too many regressors ({0}) specified, only {1} in the model"), - TOO_SMALL_COST_RELATIVE_TOLERANCE("cost relative tolerance is too small ({0}), no further reduction in the sum of squares is possible"), - TOO_SMALL_INTEGRATION_INTERVAL("too small integration interval: length = {0}"), - TOO_SMALL_ORTHOGONALITY_TOLERANCE("orthogonality tolerance is too small ({0}), solution is orthogonal to the jacobian"), - TOO_SMALL_PARAMETERS_RELATIVE_TOLERANCE("parameters relative tolerance is too small ({0}), no further improvement in the approximate solution is possible"), - TRUST_REGION_STEP_FAILED("trust region step has failed to reduce Q"), - TWO_OR_MORE_CATEGORIES_REQUIRED("two or more categories required, got {0}"), - TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED("two or more values required in each category, one has {0}"), - UNABLE_TO_BRACKET_OPTIMUM_IN_LINE_SEARCH("unable to bracket optimum in line search"), - UNABLE_TO_COMPUTE_COVARIANCE_SINGULAR_PROBLEM("unable to compute covariances: singular problem"), - UNABLE_TO_FIRST_GUESS_HARMONIC_COEFFICIENTS("unable to first guess the harmonic coefficients"), - UNABLE_TO_ORTHOGONOLIZE_MATRIX("unable to orthogonalize matrix in {0} iterations"), - UNABLE_TO_PERFORM_QR_DECOMPOSITION_ON_JACOBIAN("unable to perform Q.R decomposition on the {0}x{1} jacobian matrix"), - UNABLE_TO_SOLVE_SINGULAR_PROBLEM("unable to solve: singular problem"), - UNBOUNDED_SOLUTION("unbounded solution"), - UNKNOWN_MODE("unknown mode {0}, known modes: {1} ({2}), {3} ({4}), {5} ({6}), {7} ({8}), {9} ({10}) and {11} ({12})"), - UNKNOWN_PARAMETER("unknown parameter {0}"), - UNMATCHED_ODE_IN_EXPANDED_SET("ode does not match the main ode set in the extended set"), - CANNOT_PARSE_AS_TYPE("string \"{0}\" unparseable (from position {1}) as an object of type {2}"), /* keep */ - CANNOT_PARSE("string \"{0}\" unparseable (from position {1})"), /* keep */ - UNPARSEABLE_3D_VECTOR("unparseable 3D vector: \"{0}\""), - UNPARSEABLE_COMPLEX_NUMBER("unparseable complex number: \"{0}\""), - UNPARSEABLE_REAL_VECTOR("unparseable real vector: \"{0}\""), - UNSUPPORTED_EXPANSION_MODE("unsupported expansion mode {0}, supported modes are {1} ({2}) and {3} ({4})"), - UNSUPPORTED_OPERATION("unsupported operation"), /* keep */ - ARITHMETIC_EXCEPTION("arithmetic exception"), /* keep */ - ILLEGAL_STATE("illegal state"), /* keep */ - USER_EXCEPTION("exception generated in user code"), /* keep */ - URL_CONTAINS_NO_DATA("URL {0} contains no data"), - VALUES_ADDED_BEFORE_CONFIGURING_STATISTIC("{0} values have been added before statistic is configured"), - VECTOR_LENGTH_MISMATCH("vector length mismatch: got {0} but expected {1}"), - VECTOR_MUST_HAVE_AT_LEAST_ONE_ELEMENT("vector must have at least one element"), - WEIGHT_AT_LEAST_ONE_NON_ZERO("weigth array must contain at least one non-zero value"), - WRONG_BLOCK_LENGTH("wrong array shape (block length = {0}, expected {1})"), - WRONG_NUMBER_OF_POINTS("{0} points are required, got only {1}"), - NUMBER_OF_POINTS("number of points ({0})"), /* keep */ - ZERO_DENOMINATOR("denominator must be different from 0"), /* keep */ - ZERO_DENOMINATOR_IN_FRACTION("zero denominator in fraction {0}/{1}"), - ZERO_FRACTION_TO_DIVIDE_BY("the fraction to divide by must not be zero: {0}/{1}"), - ZERO_NORM("zero norm"), - ZERO_NORM_FOR_ROTATION_AXIS("zero norm for rotation axis"), - ZERO_NORM_FOR_ROTATION_DEFINING_VECTOR("zero norm for rotation defining vector"), - ZERO_NOT_ALLOWED("zero not allowed here"); - - // CHECKSTYLE: resume JavadocVariable - // CHECKSTYLE: resume MultipleVariableDeclarations - - - /** Source English format. */ - private final String sourceFormat; - - /** Simple constructor. - * @param sourceFormat source English format to use when no - * localized version is available - */ - private LocalizedFormats(final String sourceFormat) { - this.sourceFormat = sourceFormat; - } - - /** {@inheritDoc} */ - public String getSourceString() { - return sourceFormat; - } - - /** {@inheritDoc} */ - public String getLocalizedString(final Locale locale) { - try { - final String path = LocalizedFormats.class.getName().replaceAll("\\.", "/"); - ResourceBundle bundle = - ResourceBundle.getBundle("assets/" + path, locale); - if (bundle.getLocale().getLanguage().equals(locale.getLanguage())) { - // the value of the resource is the translated format - return bundle.getString(toString()); - } - - } catch (MissingResourceException mre) { // NOPMD - // do nothing here - } - - // either the locale is not supported or the resource is unknown - // don't translate and fall back to using the source format - return sourceFormat; - - } - -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/exception/util/package-info.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/exception/util/package-info.java b/src/main/java/org/apache/commons/math3/exception/util/package-info.java deleted file mode 100644 index 6439a8d..0000000 --- a/src/main/java/org/apache/commons/math3/exception/util/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -/** - * - * Classes supporting exception localization. - * - */ -package org.apache.commons.math3.exception.util; http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/filter/DefaultMeasurementModel.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/filter/DefaultMeasurementModel.java b/src/main/java/org/apache/commons/math3/filter/DefaultMeasurementModel.java deleted file mode 100644 index 10c6f2b..0000000 --- a/src/main/java/org/apache/commons/math3/filter/DefaultMeasurementModel.java +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.filter; - -import org.apache.commons.math3.exception.DimensionMismatchException; -import org.apache.commons.math3.exception.NoDataException; -import org.apache.commons.math3.exception.NullArgumentException; -import org.apache.commons.math3.linear.Array2DRowRealMatrix; -import org.apache.commons.math3.linear.RealMatrix; - -/** - * Default implementation of a {@link MeasurementModel} for the use with a {@link KalmanFilter}. - * - * @since 3.0 - */ -public class DefaultMeasurementModel implements MeasurementModel { - - /** - * The measurement matrix, used to associate the measurement vector to the - * internal state estimation vector. - */ - private RealMatrix measurementMatrix; - - /** - * The measurement noise covariance matrix. - */ - private RealMatrix measurementNoise; - - /** - * Create a new {@link MeasurementModel}, taking double arrays as input parameters for the - * respective measurement matrix and noise. - * - * @param measMatrix - * the measurement matrix - * @param measNoise - * the measurement noise matrix - * @throws NullArgumentException - * if any of the input matrices is {@code null} - * @throws NoDataException - * if any row / column dimension of the input matrices is zero - * @throws DimensionMismatchException - * if any of the input matrices is non-rectangular - */ - public DefaultMeasurementModel(final double[][] measMatrix, final double[][] measNoise) - throws NullArgumentException, NoDataException, DimensionMismatchException { - this(new Array2DRowRealMatrix(measMatrix), new Array2DRowRealMatrix(measNoise)); - } - - /** - * Create a new {@link MeasurementModel}, taking {@link RealMatrix} objects - * as input parameters for the respective measurement matrix and noise. - * - * @param measMatrix the measurement matrix - * @param measNoise the measurement noise matrix - */ - public DefaultMeasurementModel(final RealMatrix measMatrix, final RealMatrix measNoise) { - this.measurementMatrix = measMatrix; - this.measurementNoise = measNoise; - } - - /** {@inheritDoc} */ - public RealMatrix getMeasurementMatrix() { - return measurementMatrix; - } - - /** {@inheritDoc} */ - public RealMatrix getMeasurementNoise() { - return measurementNoise; - } -} http://git-wip-us.apache.org/repos/asf/commons-math/blob/a7b4803f/src/main/java/org/apache/commons/math3/filter/DefaultProcessModel.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math3/filter/DefaultProcessModel.java b/src/main/java/org/apache/commons/math3/filter/DefaultProcessModel.java deleted file mode 100644 index 732e2c1..0000000 --- a/src/main/java/org/apache/commons/math3/filter/DefaultProcessModel.java +++ /dev/null @@ -1,165 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.math3.filter; - -import org.apache.commons.math3.exception.DimensionMismatchException; -import org.apache.commons.math3.exception.NoDataException; -import org.apache.commons.math3.exception.NullArgumentException; -import org.apache.commons.math3.linear.Array2DRowRealMatrix; -import org.apache.commons.math3.linear.ArrayRealVector; -import org.apache.commons.math3.linear.RealMatrix; -import org.apache.commons.math3.linear.RealVector; - -/** - * Default implementation of a {@link ProcessModel} for the use with a {@link KalmanFilter}. - * - * @since 3.0 - */ -public class DefaultProcessModel implements ProcessModel { - /** - * The state transition matrix, used to advance the internal state estimation each time-step. - */ - private RealMatrix stateTransitionMatrix; - - /** - * The control matrix, used to integrate a control input into the state estimation. - */ - private RealMatrix controlMatrix; - - /** The process noise covariance matrix. */ - private RealMatrix processNoiseCovMatrix; - - /** The initial state estimation of the observed process. */ - private RealVector initialStateEstimateVector; - - /** The initial error covariance matrix of the observed process. */ - private RealMatrix initialErrorCovMatrix; - - /** - * Create a new {@link ProcessModel}, taking double arrays as input parameters. - * - * @param stateTransition - * the state transition matrix - * @param control - * the control matrix - * @param processNoise - * the process noise matrix - * @param initialStateEstimate - * the initial state estimate vector - * @param initialErrorCovariance - * the initial error covariance matrix - * @throws NullArgumentException - * if any of the input arrays is {@code null} - * @throws NoDataException - * if any row / column dimension of the input matrices is zero - * @throws DimensionMismatchException - * if any of the input matrices is non-rectangular - */ - public DefaultProcessModel(final double[][] stateTransition, - final double[][] control, - final double[][] processNoise, - final double[] initialStateEstimate, - final double[][] initialErrorCovariance) - throws NullArgumentException, NoDataException, DimensionMismatchException { - - this(new Array2DRowRealMatrix(stateTransition), - new Array2DRowRealMatrix(control), - new Array2DRowRealMatrix(processNoise), - new ArrayRealVector(initialStateEstimate), - new Array2DRowRealMatrix(initialErrorCovariance)); - } - - /** - * Create a new {@link ProcessModel}, taking double arrays as input parameters. - * <p> - * The initial state estimate and error covariance are omitted and will be initialized by the - * {@link KalmanFilter} to default values. - * - * @param stateTransition - * the state transition matrix - * @param control - * the control matrix - * @param processNoise - * the process noise matrix - * @throws NullArgumentException - * if any of the input arrays is {@code null} - * @throws NoDataException - * if any row / column dimension of the input matrices is zero - * @throws DimensionMismatchException - * if any of the input matrices is non-rectangular - */ - public DefaultProcessModel(final double[][] stateTransition, - final double[][] control, - final double[][] processNoise) - throws NullArgumentException, NoDataException, DimensionMismatchException { - - this(new Array2DRowRealMatrix(stateTransition), - new Array2DRowRealMatrix(control), - new Array2DRowRealMatrix(processNoise), null, null); - } - - /** - * Create a new {@link ProcessModel}, taking double arrays as input parameters. - * - * @param stateTransition - * the state transition matrix - * @param control - * the control matrix - * @param processNoise - * the process noise matrix - * @param initialStateEstimate - * the initial state estimate vector - * @param initialErrorCovariance - * the initial error covariance matrix - */ - public DefaultProcessModel(final RealMatrix stateTransition, - final RealMatrix control, - final RealMatrix processNoise, - final RealVector initialStateEstimate, - final RealMatrix initialErrorCovariance) { - this.stateTransitionMatrix = stateTransition; - this.controlMatrix = control; - this.processNoiseCovMatrix = processNoise; - this.initialStateEstimateVector = initialStateEstimate; - this.initialErrorCovMatrix = initialErrorCovariance; - } - - /** {@inheritDoc} */ - public RealMatrix getStateTransitionMatrix() { - return stateTransitionMatrix; - } - - /** {@inheritDoc} */ - public RealMatrix getControlMatrix() { - return controlMatrix; - } - - /** {@inheritDoc} */ - public RealMatrix getProcessNoise() { - return processNoiseCovMatrix; - } - - /** {@inheritDoc} */ - public RealVector getInitialStateEstimate() { - return initialStateEstimateVector; - } - - /** {@inheritDoc} */ - public RealMatrix getInitialErrorCovariance() { - return initialErrorCovMatrix; - } -}
