Source code for qf_lib.common.utils.numberutils.is_finite_number

#     Copyright 2016-present CERN – European Organization for Nuclear Research
#     Licensed 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
#     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.

import numbers
from decimal import Decimal

import numpy as np

[docs]def is_finite_number(variable) -> bool: """ Checks if the given variable is number and if it is finite. Parameters ---------- variable variable to be tested Returns ------- bool True if the variable is the finite number, False otherwise """ if variable is not None and isinstance(variable, numbers.Number): if isinstance(variable, Decimal): return variable.is_finite() return np.isfinite(variable) return False