/*
* 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.linear;
import org.apache.commons.math3.exception.NumberIsTooSmallException;
import org.apache.commons.math3.exception.util.LocalizedFormats;
import org.apache.commons.math3.exception.util.ExceptionContext;
/**
* Exception to be thrown when a positive definite matrix is expected.
*
* @since 3.0
*/
public class NonPositiveDefiniteMatrixException extends NumberIsTooSmallException {
/** Serializable version Id. */
private static final long serialVersionUID = 1641613838113738061L;
/** Index (diagonal element). */
private final int index;
/** Threshold. */
private final double threshold;
/**
* Construct an exception.
*
* @param wrong Value that fails the positivity check.
* @param index Row (and column) index.
* @param threshold Absolute positivity threshold.
*/
public NonPositiveDefiniteMatrixException(double wrong,
int index,
double threshold) {
super(wrong, threshold, false);
this.index = index;
this.threshold = threshold;
final ExceptionContext context = getContext();
context.addMessage(LocalizedFormats.NOT_POSITIVE_DEFINITE_MATRIX);
context.addMessage(LocalizedFormats.ARRAY_ELEMENT, wrong, index);
}
/**
* @return the row index.
*/
public int getRow() {
return index;
}
/**
* @return the column index.
*/
public int getColumn() {
return index;
}
/**
* @return the absolute positivity threshold.
*/
public double getThreshold() {
return threshold;
}
}