1

我遇到了一个 scipy 函数,无论传递给它什么,它似乎都会返回一个 numpy 数组。在我的应用程序中,我只需要能够传递标量和列表,因此唯一的“问题”是当我将标量传递给函数时,会返回一个包含一个元素的数组(当我期望一个标量时)。我应该忽略这种行为,还是修改函数以确保在传递标量时返回标量?

示例代码:

#! /usr/bin/env python

import scipy
import scipy.optimize
from numpy import cos

# This a some function we want to compute the inverse of
def f(x):
    y = x + 2*cos(x)
    return y

# Given y, this returns x such that f(x)=y
def f_inverse(y):

    # This will be zero if f(x)=y
    def minimize_this(x):
        return y-f(x)

    # A guess for the solution is required
    x_guess = y
    x_optimized = scipy.optimize.fsolve(minimize_this, x_guess) # THE PROBLEM COMES FROM HERE
    return x_optimized

# If I call f_inverse with a list, a numpy array is returned
print f_inverse([1.0, 2.0, 3.0])
print type( f_inverse([1.0, 2.0, 3.0]) )

# If I call f_inverse with a tuple, a numpy array is returned
print f_inverse((1.0, 2.0, 3.0))
print type( f_inverse((1.0, 2.0, 3.0)) )

# If I call f_inverse with a scalar, a numpy array is returned
print f_inverse(1.0)
print type( f_inverse(1.0) )

# This is the behaviour I expected (scalar passed, scalar returned).
# Adding [0] on the return value is a hackey solution (then thing would break if a list were actually passed).
print f_inverse(1.0)[0] # <- bad solution
print type( f_inverse(1.0)[0] )

在我的系统上,这个输出是:

[ 2.23872989  1.10914418  4.1187546 ]
<type 'numpy.ndarray'>
[ 2.23872989  1.10914418  4.1187546 ]
<type 'numpy.ndarray'>
[ 2.23872989]
<type 'numpy.ndarray'>
2.23872989209
<type 'numpy.float64'>

我正在使用 MacPorts 提供的 SciPy 0.10.1 和 Python 2.7.3。

解决方案

阅读下面的答案后,我选择了以下解决方案。将返回行替换为f_inverse

if(type(y).__module__ == np.__name__):
    return x_optimized
else:
    return type(y)(x_optimized)

这里return type(y)(x_optimized)导致返回类型与调用函数的类型相同。不幸的是,如果 y 是 numpy 类型,则这不起作用,因此if(type(y).__module__ == np.__name__)用于使用此处提出的想法检测 numpy 类型并将它们从类型转换中排除。

4

4 回答 4

3

实现的第一行scipy.optimize.fsolve是:

x0 = array(x0, ndmin=1)

这意味着您的标量将变成一个 1 元素序列,而您的 1 元素序列将基本保持不变。

它似乎工作的事实是一个实现细节,我会重构您的代码以不允许将标量发送到fsolve. 我知道这似乎违背了鸭子类型,但是该函数要求一个ndarray用于该参数的参数,因此您应该尊重接口对实现更改的鲁棒性。但是,我没有看到有条件地使用x_guess = array(y, ndmin=1)for 将标量转换为ndarray包装函数中的任何问题,并在必要时将结果转换回标量。

这是fsolve函数文档字符串的相关部分:

def fsolve(func, x0, args=(), fprime=None, full_output=0,
           col_deriv=0, xtol=1.49012e-8, maxfev=0, band=None,
           epsfcn=0.0, factor=100, diag=None):
    """
    Find the roots of a function.

    Return the roots of the (non-linear) equations defined by
    ``func(x) = 0`` given a starting estimate.

    Parameters
    ----------
    func : callable f(x, *args)
        A function that takes at least one (possibly vector) argument.
    x0 : ndarray
        The starting estimate for the roots of ``func(x) = 0``.

    ----SNIP----

    Returns
    -------
    x : ndarray
        The solution (or the result of the last iteration for
        an unsuccessful call).

    ----SNIP----
于 2012-09-24T13:21:05.523 回答
2

以下是如何将 Numpy 数组转换为列表以及将 Numpy 标量转换为 Python 标量的方法:

>>> x = np.float32(42)
>>> type(x)
<type 'numpy.float32'>
>>> x.tolist()
42.0

换句话说,该tolist方法np.ndarray专门处理标量。

这仍然会给您留下单元素列表,但这些列表很容易以通常的方式处理。

于 2012-09-24T15:04:51.357 回答
1

我猜wims的回答确实已经说得很清楚了,但这也许会使差异更加清晰。

numpy 返回的标量array[0]应该(几乎?)与标准 python 浮点数完全兼容:

a = np.ones(2, dtype=float)
isinstance(a[0], float) == True # even this is true.

在大多数情况下,1 大小的数组已经兼容标量和列表,尽管例如它是一个可变对象,而浮点不是:

a = np.ones(1, dtype=float)
import math
math.exp(a) # works
# it is not isinstance though
isinstance(a, float) == False
# The 1-sized array works sometimes more like number:
bool(np.zeros(1)) == bool(np.asscalar(np.zeros(1)))
# While lists would be always True if they have more then one element.
bool([0]) != bool(np.zeros(1))

# And being in place might create confusion:
a = np.ones(1); c = a; c += 3
b = 1.; c = b; c += 3
a != b

因此,如果用户不应该知道它,我认为第一个很好,第二个很危险。

您还可以使用np.asscalar(result)将大小为 1 的数组(任何维度)转换为正确的 python 标量:

在[29]中:类型(np.asscalar(a[0]))在[29]中:浮点数

如果您想确保不应该了解 numpy 的用户不会感到意外,那么如果传入了标量,您至少必须获取 0 的元素。如果用户应该知道 numpy,那么文档就是可能一样好。

于 2012-09-24T14:19:34.417 回答
1

正如@wim 指出的那样,fsolve将您的标量转换为 a ndarrayof shape(1,)并返回一个 shape 数组(1,)

如果您真的想获得一个标量作为输出,您可以尝试将以下内容放在函数的末尾:

if solution.size == 1:
    return solution.item()
return solution

(该item方法复制一个数组元素并返回一个标准 Python 标量)

于 2012-09-24T14:29:40.933 回答