rational_interpolant_utils.py
No OneTemporary
Actions

Subscribers

None

File Metadata

	# Copyright (C) 2018 by the RROMPy authors
	#
	# This file is part of RROMPy.
	#
	# RROMPy is free software: you can redistribute it and/or modify
	# it under the terms of the GNU Lesser General Public License as published by
	# the Free Software Foundation, either version 3 of the License, or
	# (at your option) any later version.
	#
	# RROMPy is distributed in the hope that it will be useful,
	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	# GNU Lesser General Public License for more details.
	#
	# You should have received a copy of the GNU Lesser General Public License
	# along with RROMPy. If not, see <http://www.gnu.org/licenses/>.
	#

	import numpy as np
	from rrompy.utilities.base.types import Np1D
	from rrompy.utilities.exception_manager import RROMPyWarning

	__all__ = ['checkRobustTolerance']

	def checkRobustTolerance(ev:Np1D, N:int, tol:float) -> dict:
	"""
	Perform robustness check on eigen-/singular values and return reduced
	parameters with warning.
	"""
	ts = tol * np.linalg.norm(ev)
	if len(ev) <= np.sum(np.abs(ev) >= ts) + 1: return {}
	RROMPyWarning(("Smallest {} eigenvalues below tolerance. Reducing N by "
	"1.").format(len(ev) - np.sum(np.abs(ev) >= ts)))
	return {"N" : N - 1}