001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math4.neuralnet.internal;
018
019import java.text.MessageFormat;
020
021/**
022 * Exception class with constants for frequently used messages.
023 */
024public class NeuralNetException extends IllegalArgumentException {
025    /** Error message for "out of range" condition. */
026    public static final String OUT_OF_RANGE = "Number {0} is out of range [{1}, {2}]";
027    /** Error message for "not strictly positive" condition. */
028    public static final String NOT_STRICTLY_POSITIVE = "Number {0} is not strictly positive";
029    /** Error message for "too large" condition. */
030    public static final String TOO_LARGE = "Number {0} is larger than {1}";
031    /** Error message for "too small" condition. */
032    public static final String TOO_SMALL = "Number {0} is smaller than {1}";
033    /** Error message for "out of range" condition. */
034    public static final String NO_DATA = "No data";
035    /** Error message for "size mismatch" condition. */
036    public static final String SIZE_MISMATCH = "Size mismatch: {0} != {1}";
037    /** Error message for "identifier already used" condition. */
038    public static final String ID_IN_USE = "Identifier already in use: {0}";
039    /** Error message for "identifier not found" condition. */
040    public static final String ID_NOT_FOUND = "Identifier not found: {0}";
041
042    /** Serializable version identifier. */
043    private static final long serialVersionUID = 20210515L;
044
045    /**
046     * Create an exception where the message is constructed by applying
047     * the {@code format()} method from {@code java.text.MessageFormat}.
048     *
049     * @param message Message format (with replaceable parameters).
050     * @param formatArguments Actual arguments to be displayed in the message.
051     */
052    public NeuralNetException(String message, Object... formatArguments) {
053        super(MessageFormat.format(message, formatArguments));
054    }
055}