mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-07-09 16:22:07 +08:00
mapd: Remove preloaded dependencies (#112)
This commit is contained in:
-1
@@ -1 +0,0 @@
|
||||
pip
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2014 PhiBo (DinoTools)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
-125
@@ -1,125 +0,0 @@
|
||||
Metadata-Version: 2.1
|
||||
Name: overpy
|
||||
Version: 0.6
|
||||
Summary: Python Wrapper to access the OpenStreepMap Overpass API
|
||||
Home-page: https://github.com/DinoTools/python-overpy
|
||||
Author: PhiBo (DinoTools)
|
||||
License: MIT
|
||||
Project-URL: Documentation, https://python-overpy.readthedocs.io/
|
||||
Project-URL: Source, https://github.com/DinoTools/python-overpy
|
||||
Project-URL: Issue Tracker, https://github.com/DinoTools/python-overpy/issues
|
||||
Keywords: OverPy Overpass OSM OpenStreetMap
|
||||
Classifier: Development Status :: 4 - Beta
|
||||
Classifier: License :: OSI Approved :: MIT License
|
||||
Classifier: Operating System :: OS Independent
|
||||
Classifier: Programming Language :: Python
|
||||
Classifier: Programming Language :: Python :: 3
|
||||
Classifier: Programming Language :: Python :: 3.6
|
||||
Classifier: Programming Language :: Python :: 3.7
|
||||
Classifier: Programming Language :: Python :: 3.8
|
||||
Classifier: Programming Language :: Python :: 3.9
|
||||
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||||
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||||
Requires-Python: >=3.6
|
||||
Description-Content-Type: text/x-rst
|
||||
License-File: LICENSE
|
||||
|
||||
Python Overpass Wrapper
|
||||
=======================
|
||||
|
||||
A Python Wrapper to access the Overpass API.
|
||||
|
||||
Have a look at the `documentation`_ to find additional information.
|
||||
|
||||
.. image:: https://img.shields.io/pypi/v/overpy.svg
|
||||
:target: https://pypi.python.org/pypi/overpy/
|
||||
:alt: Latest Version
|
||||
|
||||
.. image:: https://img.shields.io/pypi/l/overpy.svg
|
||||
:target: https://pypi.python.org/pypi/overpy/
|
||||
:alt: License
|
||||
|
||||
.. image:: https://github.com/DinoTools/python-overpy/actions/workflows/ci.yml/badge.svg?branch=master
|
||||
:target: https://github.com/DinoTools/python-overpy/actions/workflows/ci.yml?query=branch%3Amaster+
|
||||
|
||||
.. image:: https://coveralls.io/repos/DinoTools/python-overpy/badge.png?branch=master
|
||||
:target: https://coveralls.io/r/DinoTools/python-overpy?branch=master
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* Query Overpass API
|
||||
* Parse JSON and XML response data
|
||||
* Additional helper functions
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
**Requirements:**
|
||||
|
||||
Supported Python versions:
|
||||
|
||||
* Python >= 3.6
|
||||
* PyPy3
|
||||
|
||||
**Install:**
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install overpy
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Additional examples can be found in the `documentation`_ and in the *examples* directory.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import overpy
|
||||
|
||||
api = overpy.Overpass()
|
||||
|
||||
# fetch all ways and nodes
|
||||
result = api.query("""
|
||||
way(50.746,7.154,50.748,7.157) ["highway"];
|
||||
(._;>;);
|
||||
out body;
|
||||
""")
|
||||
|
||||
for way in result.ways:
|
||||
print("Name: %s" % way.tags.get("name", "n/a"))
|
||||
print(" Highway: %s" % way.tags.get("highway", "n/a"))
|
||||
print(" Nodes:")
|
||||
for node in way.nodes:
|
||||
print(" Lat: %f, Lon: %f" % (node.lat, node.lon))
|
||||
|
||||
|
||||
Helper
|
||||
~~~~~~
|
||||
|
||||
Helper methods are available to provide easy access to often used requests.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import overpy.helper
|
||||
|
||||
# 3600062594 is the OSM id of Chemnitz and is the bounding box for the request
|
||||
street = overpy.helper.get_street(
|
||||
"Straße der Nationen",
|
||||
"3600062594"
|
||||
)
|
||||
|
||||
# this finds an intersection between Straße der Nationen and Carolastraße in Chemnitz
|
||||
intersection = overpy.helper.get_intersection(
|
||||
"Straße der Nationen",
|
||||
"Carolastraße",
|
||||
"3600062594"
|
||||
)
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Published under the MIT (see LICENSE for more information)
|
||||
|
||||
.. _`documentation`: http://python-overpy.readthedocs.org/
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
overpy-0.6.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
overpy-0.6.dist-info/LICENSE,sha256=a10N2C2Las6J2gATvr32uDtYSB2nAd8C5XW0cVlroBI,1084
|
||||
overpy-0.6.dist-info/METADATA,sha256=dwaoOpofBy-H9gNZKwbCB06rvM89FrzN5vt-WcYXzZ0,3458
|
||||
overpy-0.6.dist-info/RECORD,,
|
||||
overpy-0.6.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
overpy-0.6.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
|
||||
overpy-0.6.dist-info/top_level.txt,sha256=FiaqzHIMidUeLrHBRTIvBi8VRsSXXisK7IeJwiZvIZs,7
|
||||
overpy/__about__.py,sha256=jFFo43qrDi1Qt0wCOhmJaoaPjygB_fC83K9K2oaEPR0,453
|
||||
overpy/__init__.py,sha256=RKzCa20y8kI-74WJglKujKOIknCxaEsTB2FcYWHnHek,52663
|
||||
overpy/__pycache__/__about__.cpython-38.pyc,,
|
||||
overpy/__pycache__/__init__.cpython-38.pyc,,
|
||||
overpy/__pycache__/exception.cpython-38.pyc,,
|
||||
overpy/__pycache__/helper.cpython-38.pyc,,
|
||||
overpy/exception.py,sha256=TfOq2SVo_56acHg569Eoze0ETW62c1vgJBPumUMNVys,4753
|
||||
overpy/helper.py,sha256=J1es5zRLrhEQnlONTYfsIhEsxvv0WLtU8D-lzFYtyGg,1724
|
||||
-5
@@ -1,5 +0,0 @@
|
||||
Wheel-Version: 1.0
|
||||
Generator: bdist_wheel (0.37.1)
|
||||
Root-Is-Purelib: true
|
||||
Tag: py3-none-any
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
overpy
|
||||
Vendored
-22
@@ -1,22 +0,0 @@
|
||||
__all__ = [
|
||||
"__author__",
|
||||
"__copyright__",
|
||||
"__email__",
|
||||
"__license__",
|
||||
"__summary__",
|
||||
"__title__",
|
||||
"__uri__",
|
||||
"__version__",
|
||||
]
|
||||
|
||||
__title__ = "overpy"
|
||||
__summary__ = "Python Wrapper to access the OpenStreepMap Overpass API"
|
||||
__uri__ = "https://github.com/DinoTools/python-overpy"
|
||||
|
||||
__version__ = "0.6"
|
||||
|
||||
__author__ = "PhiBo (DinoTools)"
|
||||
__email__ = ""
|
||||
|
||||
__license__ = "MIT"
|
||||
__copyright__ = "Copyright 2014-2021 %s" % __author__
|
||||
Vendored
-1614
File diff suppressed because it is too large
Load Diff
Vendored
-166
@@ -1,166 +0,0 @@
|
||||
class OverPyException(Exception):
|
||||
"""OverPy base exception"""
|
||||
pass
|
||||
|
||||
|
||||
class DataIncomplete(OverPyException):
|
||||
"""
|
||||
Raised if the requested data isn't available in the result.
|
||||
Try to improve the query or to resolve the missing data.
|
||||
"""
|
||||
def __init__(self, *args, **kwargs):
|
||||
OverPyException.__init__(
|
||||
self,
|
||||
"Data incomplete try to improve the query to resolve the missing data",
|
||||
*args,
|
||||
**kwargs
|
||||
)
|
||||
|
||||
|
||||
class ElementDataWrongType(OverPyException):
|
||||
"""
|
||||
Raised if the provided element does not match the expected type.
|
||||
|
||||
:param type_expected: The expected element type
|
||||
:type type_expected: String
|
||||
:param type_provided: The provided element type
|
||||
:type type_provided: String|None
|
||||
"""
|
||||
def __init__(self, type_expected, type_provided=None):
|
||||
self.type_expected = type_expected
|
||||
self.type_provided = type_provided
|
||||
|
||||
def __str__(self):
|
||||
return "Type expected '{}' but '{}' provided".format(
|
||||
self.type_expected,
|
||||
str(self.type_provided)
|
||||
)
|
||||
|
||||
|
||||
class MaxRetriesReached(OverPyException):
|
||||
"""
|
||||
Raised if max retries reached and the Overpass server didn't respond with a result.
|
||||
"""
|
||||
def __init__(self, retry_count, exceptions):
|
||||
self.exceptions = exceptions
|
||||
self.retry_count = retry_count
|
||||
|
||||
def __str__(self):
|
||||
return "Unable get any result from the Overpass API server after %d retries." % self.retry_count
|
||||
|
||||
|
||||
class OverpassBadRequest(OverPyException):
|
||||
"""
|
||||
Raised if the Overpass API service returns a syntax error.
|
||||
|
||||
:param query: The encoded query how it was send to the server
|
||||
:type query: Bytes
|
||||
:param msgs: List of error messages
|
||||
:type msgs: List
|
||||
"""
|
||||
def __init__(self, query, msgs=None):
|
||||
self.query = query
|
||||
if msgs is None:
|
||||
msgs = []
|
||||
self.msgs = msgs
|
||||
|
||||
def __str__(self):
|
||||
tmp_msgs = []
|
||||
for tmp_msg in self.msgs:
|
||||
if not isinstance(tmp_msg, str):
|
||||
tmp_msg = str(tmp_msg)
|
||||
tmp_msgs.append(tmp_msg)
|
||||
|
||||
return "\n".join(tmp_msgs)
|
||||
|
||||
|
||||
class OverpassError(OverPyException):
|
||||
"""
|
||||
Base exception to report errors if the response returns a remark tag or element.
|
||||
|
||||
.. note::
|
||||
If you are not sure which of the subexceptions you should use, use this one and try to parse the message.
|
||||
|
||||
For more information have a look at https://github.com/DinoTools/python-overpy/issues/62
|
||||
|
||||
:param str msg: The message from the remark tag or element
|
||||
"""
|
||||
def __init__(self, msg=None):
|
||||
#: The message from the remark tag or element
|
||||
self.msg = msg
|
||||
|
||||
def __str__(self):
|
||||
if self.msg is None:
|
||||
return "No error message provided"
|
||||
if not isinstance(self.msg, str):
|
||||
return str(self.msg)
|
||||
return self.msg
|
||||
|
||||
|
||||
class OverpassGatewayTimeout(OverPyException):
|
||||
"""
|
||||
Raised if load of the Overpass API service is too high and it can't handle the request.
|
||||
"""
|
||||
def __init__(self):
|
||||
OverPyException.__init__(self, "Server load too high")
|
||||
|
||||
|
||||
class OverpassRuntimeError(OverpassError):
|
||||
"""
|
||||
Raised if the server returns a remark-tag(xml) or remark element(json) with a message starting with
|
||||
'runtime error:'.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
class OverpassRuntimeRemark(OverpassError):
|
||||
"""
|
||||
Raised if the server returns a remark-tag(xml) or remark element(json) with a message starting with
|
||||
'runtime remark:'.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
class OverpassTooManyRequests(OverPyException):
|
||||
"""
|
||||
Raised if the Overpass API service returns a 429 status code.
|
||||
"""
|
||||
def __init__(self):
|
||||
OverPyException.__init__(self, "Too many requests")
|
||||
|
||||
|
||||
class OverpassUnknownContentType(OverPyException):
|
||||
"""
|
||||
Raised if the reported content type isn't handled by OverPy.
|
||||
|
||||
:param content_type: The reported content type
|
||||
:type content_type: None or String
|
||||
"""
|
||||
def __init__(self, content_type):
|
||||
self.content_type = content_type
|
||||
|
||||
def __str__(self):
|
||||
if self.content_type is None:
|
||||
return "No content type returned"
|
||||
return "Unknown content type: %s" % self.content_type
|
||||
|
||||
|
||||
class OverpassUnknownError(OverpassError):
|
||||
"""
|
||||
Raised if the server returns a remark-tag(xml) or remark element(json) and we are unable to find any reason.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
class OverpassUnknownHTTPStatusCode(OverPyException):
|
||||
"""
|
||||
Raised if the returned HTTP status code isn't handled by OverPy.
|
||||
|
||||
:param code: The HTTP status code
|
||||
:type code: Integer
|
||||
"""
|
||||
def __init__(self, code):
|
||||
self.code = code
|
||||
|
||||
def __str__(self):
|
||||
return "Unknown/Unhandled status code: %d" % self.code
|
||||
Vendored
-64
@@ -1,64 +0,0 @@
|
||||
__author__ = 'mjob'
|
||||
|
||||
import overpy
|
||||
|
||||
|
||||
def get_street(street, areacode, api=None):
|
||||
"""
|
||||
Retrieve streets in a given bounding area
|
||||
|
||||
:param overpy.Overpass api: First street of intersection
|
||||
:param String street: Name of street
|
||||
:param String areacode: The OSM id of the bounding area
|
||||
:return: Parsed result
|
||||
:raises overpy.exception.OverPyException: If something bad happens.
|
||||
"""
|
||||
if api is None:
|
||||
api = overpy.Overpass()
|
||||
|
||||
query = """
|
||||
area(%s)->.location;
|
||||
(
|
||||
way[highway][name="%s"](area.location);
|
||||
- (
|
||||
way[highway=service](area.location);
|
||||
way[highway=track](area.location);
|
||||
);
|
||||
);
|
||||
out body;
|
||||
>;
|
||||
out skel qt;
|
||||
"""
|
||||
|
||||
data = api.query(query % (areacode, street))
|
||||
|
||||
return data
|
||||
|
||||
|
||||
def get_intersection(street1, street2, areacode, api=None):
|
||||
"""
|
||||
Retrieve intersection of two streets in a given bounding area
|
||||
|
||||
:param overpy.Overpass api: First street of intersection
|
||||
:param String street1: Name of first street of intersection
|
||||
:param String street2: Name of second street of intersection
|
||||
:param String areacode: The OSM id of the bounding area
|
||||
:return: List of intersections
|
||||
:raises overpy.exception.OverPyException: If something bad happens.
|
||||
"""
|
||||
if api is None:
|
||||
api = overpy.Overpass()
|
||||
|
||||
query = """
|
||||
area(%s)->.location;
|
||||
(
|
||||
way[highway][name="%s"](area.location); node(w)->.n1;
|
||||
way[highway][name="%s"](area.location); node(w)->.n2;
|
||||
);
|
||||
node.n1.n2;
|
||||
out meta;
|
||||
"""
|
||||
|
||||
data = api.query(query % (areacode, street1, street2))
|
||||
|
||||
return data.get_nodes()
|
||||
-1
@@ -1 +0,0 @@
|
||||
pip
|
||||
-910
@@ -1,910 +0,0 @@
|
||||
Copyright (c) 2001-2002 Enthought, Inc. 2003-2019, SciPy Developers.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following
|
||||
disclaimer in the documentation and/or other materials provided
|
||||
with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived
|
||||
from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
----
|
||||
|
||||
This binary distribution of Scipy also bundles the following software:
|
||||
|
||||
|
||||
Name: OpenBLAS
|
||||
Files: .libs/libopenb*.so
|
||||
Description: bundled as a dynamically linked library
|
||||
Availability: https://github.com/xianyi/OpenBLAS/
|
||||
License: 3-clause BSD
|
||||
Copyright (c) 2011-2014, The OpenBLAS Project
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
3. Neither the name of the OpenBLAS project nor the names of
|
||||
its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written
|
||||
permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
Name: LAPACK
|
||||
Files: .libs/libopenb*.so
|
||||
Description: bundled in OpenBLAS
|
||||
Availability: https://github.com/xianyi/OpenBLAS/
|
||||
License 3-clause BSD
|
||||
Copyright (c) 1992-2013 The University of Tennessee and The University
|
||||
of Tennessee Research Foundation. All rights
|
||||
reserved.
|
||||
Copyright (c) 2000-2013 The University of California Berkeley. All
|
||||
rights reserved.
|
||||
Copyright (c) 2006-2013 The University of Colorado Denver. All rights
|
||||
reserved.
|
||||
|
||||
$COPYRIGHT$
|
||||
|
||||
Additional copyrights may follow
|
||||
|
||||
$HEADER$
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
- Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
- Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer listed
|
||||
in this license in the documentation and/or other materials
|
||||
provided with the distribution.
|
||||
|
||||
- Neither the name of the copyright holders nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
The copyright holders provide no reassurances that the source code
|
||||
provided does not infringe any patent, copyright, or any other
|
||||
intellectual property rights of third parties. The copyright holders
|
||||
disclaim any liability to any recipient for claims brought against
|
||||
recipient by any third party for infringement of that parties
|
||||
intellectual property rights.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
Name: GCC runtime library
|
||||
Files: .libs/libgfortran*.so
|
||||
Description: dynamically linked to files compiled with gcc
|
||||
Availability: https://gcc.gnu.org/viewcvs/gcc/
|
||||
License: GPLv3 + runtime exception
|
||||
Copyright (C) 2002-2017 Free Software Foundation, Inc.
|
||||
|
||||
Libgfortran is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 3, or (at your option)
|
||||
any later version.
|
||||
|
||||
Libgfortran 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 General Public License for more details.
|
||||
|
||||
Under Section 7 of GPL version 3, you are granted additional
|
||||
permissions described in the GCC Runtime Library Exception, version
|
||||
3.1, as published by the Free Software Foundation.
|
||||
|
||||
You should have received a copy of the GNU General Public License and
|
||||
a copy of the GCC Runtime Library Exception along with this program;
|
||||
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
----
|
||||
|
||||
Full text of license texts referred to above follows (that they are
|
||||
listed below does not necessarily imply the conditions apply to the
|
||||
present binary release):
|
||||
|
||||
----
|
||||
|
||||
GCC RUNTIME LIBRARY EXCEPTION
|
||||
|
||||
Version 3.1, 31 March 2009
|
||||
|
||||
Copyright (C) 2009 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
This GCC Runtime Library Exception ("Exception") is an additional
|
||||
permission under section 7 of the GNU General Public License, version
|
||||
3 ("GPLv3"). It applies to a given file (the "Runtime Library") that
|
||||
bears a notice placed by the copyright holder of the file stating that
|
||||
the file is governed by GPLv3 along with this Exception.
|
||||
|
||||
When you use GCC to compile a program, GCC may combine portions of
|
||||
certain GCC header files and runtime libraries with the compiled
|
||||
program. The purpose of this Exception is to allow compilation of
|
||||
non-GPL (including proprietary) programs to use, in this way, the
|
||||
header files and runtime libraries covered by this Exception.
|
||||
|
||||
0. Definitions.
|
||||
|
||||
A file is an "Independent Module" if it either requires the Runtime
|
||||
Library for execution after a Compilation Process, or makes use of an
|
||||
interface provided by the Runtime Library, but is not otherwise based
|
||||
on the Runtime Library.
|
||||
|
||||
"GCC" means a version of the GNU Compiler Collection, with or without
|
||||
modifications, governed by version 3 (or a specified later version) of
|
||||
the GNU General Public License (GPL) with the option of using any
|
||||
subsequent versions published by the FSF.
|
||||
|
||||
"GPL-compatible Software" is software whose conditions of propagation,
|
||||
modification and use would permit combination with GCC in accord with
|
||||
the license of GCC.
|
||||
|
||||
"Target Code" refers to output from any compiler for a real or virtual
|
||||
target processor architecture, in executable form or suitable for
|
||||
input to an assembler, loader, linker and/or execution
|
||||
phase. Notwithstanding that, Target Code does not include data in any
|
||||
format that is used as a compiler intermediate representation, or used
|
||||
for producing a compiler intermediate representation.
|
||||
|
||||
The "Compilation Process" transforms code entirely represented in
|
||||
non-intermediate languages designed for human-written code, and/or in
|
||||
Java Virtual Machine byte code, into Target Code. Thus, for example,
|
||||
use of source code generators and preprocessors need not be considered
|
||||
part of the Compilation Process, since the Compilation Process can be
|
||||
understood as starting with the output of the generators or
|
||||
preprocessors.
|
||||
|
||||
A Compilation Process is "Eligible" if it is done using GCC, alone or
|
||||
with other GPL-compatible software, or if it is done without using any
|
||||
work based on GCC. For example, using non-GPL-compatible Software to
|
||||
optimize any GCC intermediate representations would not qualify as an
|
||||
Eligible Compilation Process.
|
||||
|
||||
1. Grant of Additional Permission.
|
||||
|
||||
You have permission to propagate a work of Target Code formed by
|
||||
combining the Runtime Library with Independent Modules, even if such
|
||||
propagation would otherwise violate the terms of GPLv3, provided that
|
||||
all Target Code was generated by Eligible Compilation Processes. You
|
||||
may then convey such a combination under terms of your choice,
|
||||
consistent with the licensing of the Independent Modules.
|
||||
|
||||
2. No Weakening of GCC Copyleft.
|
||||
|
||||
The availability of this Exception does not imply any general
|
||||
presumption that third-party software is unaffected by the copyleft
|
||||
requirements of the license of GCC.
|
||||
|
||||
----
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
@@ -1,248 +0,0 @@
|
||||
The SciPy repository and source distributions bundle a number of libraries that
|
||||
are compatibly licensed. We list these here.
|
||||
|
||||
Name: Numpydoc
|
||||
Files: doc/sphinxext/numpydoc/*
|
||||
License: 2-clause BSD
|
||||
For details, see doc/sphinxext/LICENSE.txt
|
||||
|
||||
Name: scipy-sphinx-theme
|
||||
Files: doc/scipy-sphinx-theme/*
|
||||
License: 3-clause BSD, PSF and Apache 2.0
|
||||
For details, see doc/sphinxext/LICENSE.txt
|
||||
|
||||
Name: Decorator
|
||||
Files: scipy/_lib/decorator.py
|
||||
License: 2-clause BSD
|
||||
For details, see the header inside scipy/_lib/decorator.py
|
||||
|
||||
Name: ID
|
||||
Files: scipy/linalg/src/id_dist/*
|
||||
License: 3-clause BSD
|
||||
For details, see scipy/linalg/src/id_dist/doc/doc.tex
|
||||
|
||||
Name: L-BFGS-B
|
||||
Files: scipy/optimize/lbfgsb/*
|
||||
License: BSD license
|
||||
For details, see scipy/optimize/lbfgsb/README
|
||||
|
||||
Name: LAPJVsp
|
||||
Files: scipy/sparse/csgraph/_matching.pyx
|
||||
License: 3-clause BSD
|
||||
Copyright 1987-, A. Volgenant/Amsterdam School of Economics,
|
||||
University of Amsterdam
|
||||
|
||||
Distributed under 3-clause BSD license with permission from
|
||||
University of Amsterdam.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
Name: SuperLU
|
||||
Files: scipy/sparse/linalg/dsolve/SuperLU/*
|
||||
License: 3-clause BSD
|
||||
For details, see scipy/sparse/linalg/dsolve/SuperLU/License.txt
|
||||
|
||||
Name: ARPACK
|
||||
Files: scipy/sparse/linalg/eigen/arpack/ARPACK/*
|
||||
License: 3-clause BSD
|
||||
For details, see scipy/sparse/linalg/eigen/arpack/ARPACK/COPYING
|
||||
|
||||
Name: Qhull
|
||||
Files: scipy/spatial/qhull/*
|
||||
License: Qhull license (BSD-like)
|
||||
For details, see scipy/spatial/qhull/COPYING.txt
|
||||
|
||||
Name: Cephes
|
||||
Files: scipy/special/cephes/*
|
||||
License: 3-clause BSD
|
||||
Distributed under 3-clause BSD license with permission from the author,
|
||||
see https://lists.debian.org/debian-legal/2004/12/msg00295.html
|
||||
|
||||
Cephes Math Library Release 2.8: June, 2000
|
||||
Copyright 1984, 1995, 2000 by Stephen L. Moshier
|
||||
|
||||
This software is derived from the Cephes Math Library and is
|
||||
incorporated herein by permission of the author.
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of the <organization> nor the
|
||||
names of its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
|
||||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
Name: Faddeeva
|
||||
Files: scipy/special/Faddeeva.*
|
||||
License: MIT
|
||||
Copyright (c) 2012 Massachusetts Institute of Technology
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
Name: qd
|
||||
Files: scipy/special/cephes/dd_*.[ch]
|
||||
License: modified BSD license ("BSD-LBNL-License.doc")
|
||||
This work was supported by the Director, Office of Science, Division
|
||||
of Mathematical, Information, and Computational Sciences of the
|
||||
U.S. Department of Energy under contract numbers DE-AC03-76SF00098 and
|
||||
DE-AC02-05CH11231.
|
||||
|
||||
Copyright (c) 2003-2009, The Regents of the University of California,
|
||||
through Lawrence Berkeley National Laboratory (subject to receipt of
|
||||
any required approvals from U.S. Dept. of Energy) All rights reserved.
|
||||
|
||||
1. Redistribution and use in source and binary forms, with or
|
||||
without modification, are permitted provided that the following
|
||||
conditions are met:
|
||||
|
||||
(1) Redistributions of source code must retain the copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
(2) Redistributions in binary form must reproduce the copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
(3) Neither the name of the University of California, Lawrence
|
||||
Berkeley National Laboratory, U.S. Dept. of Energy nor the names
|
||||
of its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written
|
||||
permission.
|
||||
|
||||
2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
3. You are under no obligation whatsoever to provide any bug fixes,
|
||||
patches, or upgrades to the features, functionality or performance of
|
||||
the source code ("Enhancements") to anyone; however, if you choose to
|
||||
make your Enhancements available either publicly, or directly to
|
||||
Lawrence Berkeley National Laboratory, without imposing a separate
|
||||
written license agreement for such Enhancements, then you hereby grant
|
||||
the following license: a non-exclusive, royalty-free perpetual license
|
||||
to install, use, modify, prepare derivative works, incorporate into
|
||||
other computer software, distribute, and sublicense such enhancements
|
||||
or derivative works thereof, in binary and source code form.
|
||||
|
||||
Name: pypocketfft
|
||||
Files: scipy/fft/_pocketfft/[pocketfft.h, pypocketfft.cxx]
|
||||
License: 3-Clause BSD
|
||||
For details, see scipy/fft/_pocketfft/LICENSE.md
|
||||
|
||||
Name: uarray
|
||||
Files: scipy/_lib/uarray/*
|
||||
License: 3-Clause BSD
|
||||
For details, see scipy/_lib/uarray/LICENSE
|
||||
|
||||
Name: ampgo
|
||||
Files: benchmarks/benchmarks/go_benchmark_functions/*.py
|
||||
License: MIT
|
||||
Functions for testing global optimizers, forked from the AMPGO project,
|
||||
https://code.google.com/archive/p/ampgo
|
||||
|
||||
Name: pybind11
|
||||
Files: no source files are included, however pybind11 binary artifacts are
|
||||
included with every binary build of SciPy.
|
||||
License:
|
||||
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>, All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
Name: HiGHS
|
||||
Files: scipy/optimize/_highs/*
|
||||
License: MIT
|
||||
For details, see scipy/optimize/_highs/LICENCE
|
||||
|
||||
Name: Boost
|
||||
Files: scipy/_lib/boost/*
|
||||
License: Boost Software License - Version 1.0
|
||||
For details, see scipy/_lib/boost/LICENSE_1_0.txt
|
||||
-54
@@ -1,54 +0,0 @@
|
||||
Metadata-Version: 2.1
|
||||
Name: scipy
|
||||
Version: 1.7.1
|
||||
Summary: SciPy: Scientific Library for Python
|
||||
Home-page: https://www.scipy.org
|
||||
Maintainer: SciPy Developers
|
||||
Maintainer-email: scipy-dev@python.org
|
||||
License: BSD
|
||||
Download-URL: https://github.com/scipy/scipy/releases
|
||||
Project-URL: Bug Tracker, https://github.com/scipy/scipy/issues
|
||||
Project-URL: Documentation, https://docs.scipy.org/doc/scipy/reference/
|
||||
Project-URL: Source Code, https://github.com/scipy/scipy
|
||||
Platform: Windows
|
||||
Platform: Linux
|
||||
Platform: Solaris
|
||||
Platform: Mac OS-X
|
||||
Platform: Unix
|
||||
Classifier: Development Status :: 5 - Production/Stable
|
||||
Classifier: Intended Audience :: Science/Research
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: License :: OSI Approved :: BSD License
|
||||
Classifier: Programming Language :: C
|
||||
Classifier: Programming Language :: Python
|
||||
Classifier: Programming Language :: Python :: 3
|
||||
Classifier: Programming Language :: Python :: 3.7
|
||||
Classifier: Programming Language :: Python :: 3.8
|
||||
Classifier: Programming Language :: Python :: 3.9
|
||||
Classifier: Topic :: Software Development :: Libraries
|
||||
Classifier: Topic :: Scientific/Engineering
|
||||
Classifier: Operating System :: Microsoft :: Windows
|
||||
Classifier: Operating System :: POSIX :: Linux
|
||||
Classifier: Operating System :: POSIX
|
||||
Classifier: Operating System :: Unix
|
||||
Classifier: Operating System :: MacOS
|
||||
Requires-Python: >=3.7,<3.10
|
||||
License-File: LICENSE.txt
|
||||
License-File: LICENSES_bundled.txt
|
||||
Requires-Dist: numpy (<1.23.0,>=1.16.5)
|
||||
|
||||
SciPy (pronounced "Sigh Pie") is open-source software for mathematics,
|
||||
science, and engineering. The SciPy library
|
||||
depends on NumPy, which provides convenient and fast N-dimensional
|
||||
array manipulation. The SciPy library is built to work with NumPy
|
||||
arrays, and provides many user-friendly and efficient numerical
|
||||
routines such as routines for numerical integration and optimization.
|
||||
Together, they run on all popular operating systems, are quick to
|
||||
install, and are free of charge. NumPy and SciPy are easy to use,
|
||||
but powerful enough to be depended upon by some of the world's
|
||||
leading scientists and engineers. If you need to manipulate
|
||||
numbers on a computer and display or publish the results,
|
||||
give SciPy a try!
|
||||
|
||||
|
||||
|
||||
-1825
File diff suppressed because it is too large
Load Diff
-6
@@ -1,6 +0,0 @@
|
||||
Wheel-Version: 1.0
|
||||
Generator: bdist_wheel (0.36.2)
|
||||
Root-Is-Purelib: false
|
||||
Tag: cp38-cp38-manylinux_2_17_aarch64
|
||||
Tag: cp38-cp38-manylinux2014_aarch64
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
scipy
|
||||
Binary file not shown.
BIN
Binary file not shown.
Vendored
-297
@@ -1,297 +0,0 @@
|
||||
.. _hacking:
|
||||
|
||||
==================
|
||||
Ways to Contribute
|
||||
==================
|
||||
|
||||
This document aims to give an overview of the ways to contribute to SciPy. It
|
||||
tries to answer commonly asked questions and provide some insight into how the
|
||||
community process works in practice. Readers who are familiar with the SciPy
|
||||
community and are experienced Python coders may want to jump straight to the
|
||||
:ref:`contributor-toc`.
|
||||
|
||||
There are a lot of ways you can contribute:
|
||||
|
||||
- Contributing new code
|
||||
- Fixing bugs, improving documentation, and other maintenance work
|
||||
- Reviewing open pull requests
|
||||
- Triaging issues
|
||||
- Working on the `scipy.org`_ website
|
||||
- Answering questions and participating on the scipy-dev and scipy-user
|
||||
`mailing lists`_.
|
||||
|
||||
Contributing new code
|
||||
=====================
|
||||
|
||||
If you have been working with the scientific Python toolstack for a while, you
|
||||
probably have some code lying around of which you think "this could be useful
|
||||
for others too". Perhaps it's a good idea then to contribute it to SciPy or
|
||||
another open source project. The first question to ask is then, where does
|
||||
this code belong? That question is hard to answer here, so we start with a
|
||||
more specific one: *what code is suitable for putting into SciPy?*
|
||||
Almost all of the new code added to SciPy has in common that it's potentially
|
||||
useful in multiple scientific domains and it fits in the scope of existing
|
||||
SciPy subpackages (see :ref:`deciding-on-new-features`). In principle new
|
||||
subpackages can be added too, but this is far less common. For code that is
|
||||
specific to a single application, there may be an existing project that can
|
||||
use the code. Some SciKits (`scikit-learn`_, `scikit-image`_, `statsmodels`_,
|
||||
etc.) are good examples here; they have a narrower focus and because of that
|
||||
more domain-specific code than SciPy.
|
||||
|
||||
Now if you have code that you would like to see included in SciPy, how do you
|
||||
go about it? After checking that your code can be distributed in SciPy under a
|
||||
compatible license (see :ref:`license-considerations`), the first step is to
|
||||
discuss on the scipy-dev mailing list. All new features, as well as changes to
|
||||
existing code, are discussed and decided on there. You can, and probably
|
||||
should, already start this discussion before your code is finished. Remember
|
||||
that in order to be added to SciPy your code will need to be reviewed by
|
||||
someone else, so try to find someone willing to review your work while you're
|
||||
at it.
|
||||
|
||||
Assuming the outcome of the discussion on the mailing list is positive and you
|
||||
have a function or piece of code that does what you need it to do, what next?
|
||||
Before code is added to SciPy, it at least has to have good documentation, unit
|
||||
tests, benchmarks, and correct code style.
|
||||
|
||||
1. Unit tests
|
||||
In principle you should aim to create unit tests that exercise all the code
|
||||
that you are adding. This gives some degree of confidence that your code
|
||||
runs correctly, also on Python versions and hardware or OSes that you don't
|
||||
have available yourself. An extensive description of how to write unit
|
||||
tests is given in :doc:`numpy:reference/testing`, and :ref:`runtests`
|
||||
documents how to run them.
|
||||
|
||||
2. Benchmarks
|
||||
Unit tests check for correct functionality; benchmarks measure code
|
||||
performance. Not all existing SciPy code has benchmarks, but it should:
|
||||
as SciPy grows it is increasingly important to monitor execution times in
|
||||
order to catch unexpected regressions. More information about writing
|
||||
and running benchmarks is available in :ref:`benchmarking-with-asv`.
|
||||
|
||||
3. Documentation
|
||||
Clear and complete documentation is essential in order for users to be able
|
||||
to find and understand the code. Documentation for individual functions
|
||||
and classes -- which includes at least a basic description, type and
|
||||
meaning of all parameters and returns values, and usage examples in
|
||||
`doctest`_ format -- is put in docstrings. Those docstrings can be read
|
||||
within the interpreter, and are compiled into a reference guide in html and
|
||||
pdf format. Higher-level documentation for key (areas of) functionality is
|
||||
provided in tutorial format and/or in module docstrings. A guide on how to
|
||||
write documentation is given in :ref:`numpy:howto-document`, and
|
||||
:ref:`rendering-documentation` explains how to preview the documentation
|
||||
as it will appear online.
|
||||
|
||||
4. Code style
|
||||
Uniformity of style in which code is written is important to others trying
|
||||
to understand the code. SciPy follows the standard Python guidelines for
|
||||
code style, `PEP8`_. In order to check that your code conforms to PEP8,
|
||||
you can use the `pep8 package`_ style checker. Most IDEs and text editors
|
||||
have settings that can help you follow PEP8, for example by translating
|
||||
tabs by four spaces. Using `pyflakes`_ to check your code is also a good
|
||||
idea. More information is available in :ref:`pep8-scipy`.
|
||||
|
||||
A :ref:`checklist<pr-checklist>`, including these and other requirements, is
|
||||
available at the end of the example :ref:`development-workflow`.
|
||||
|
||||
Another question you may have is: *where exactly do I put my code*? To answer
|
||||
this, it is useful to understand how the SciPy public API (application
|
||||
programming interface) is defined. For most modules the API is two levels
|
||||
deep, which means your new function should appear as
|
||||
``scipy.subpackage.my_new_func``. ``my_new_func`` can be put in an existing or
|
||||
new file under ``/scipy/<subpackage>/``, its name is added to the ``__all__``
|
||||
list in that file (which lists all public functions in the file), and those
|
||||
public functions are then imported in ``/scipy/<subpackage>/__init__.py``. Any
|
||||
private functions/classes should have a leading underscore (``_``) in their
|
||||
name. A more detailed description of what the public API of SciPy is, is given
|
||||
in :ref:`scipy-api`.
|
||||
|
||||
Once you think your code is ready for inclusion in SciPy, you can send a pull
|
||||
request (PR) on Github. We won't go into the details of how to work with git
|
||||
here, this is described well in :ref:`git-development`
|
||||
and on the `Github help pages`_. When you send the PR for a new
|
||||
feature, be sure to also mention this on the scipy-dev mailing list. This can
|
||||
prompt interested people to help review your PR. Assuming that you already got
|
||||
positive feedback before on the general idea of your code/feature, the purpose
|
||||
of the code review is to ensure that the code is correct, efficient and meets
|
||||
the requirements outlined above. In many cases the code review happens
|
||||
relatively quickly, but it's possible that it stalls. If you have addressed
|
||||
all feedback already given, it's perfectly fine to ask on the mailing list
|
||||
again for review (after a reasonable amount of time, say a couple of weeks, has
|
||||
passed). Once the review is completed, the PR is merged into the "master"
|
||||
branch of SciPy.
|
||||
|
||||
The above describes the requirements and process for adding code to SciPy. It
|
||||
doesn't yet answer the question though how decisions are made exactly. The
|
||||
basic answer is: decisions are made by consensus, by everyone who chooses to
|
||||
participate in the discussion on the mailing list. This includes developers,
|
||||
other users and yourself. Aiming for consensus in the discussion is important
|
||||
-- SciPy is a project by and for the scientific Python community. In those
|
||||
rare cases that agreement cannot be reached, the maintainers of the module
|
||||
in question can decide the issue.
|
||||
|
||||
.. _license-considerations:
|
||||
|
||||
License Considerations
|
||||
----------------------
|
||||
|
||||
*I based my code on existing Matlab/R/... code I found online, is this OK?*
|
||||
|
||||
It depends. SciPy is distributed under a BSD license, so if the code that you
|
||||
based your code on is also BSD licensed or has a BSD-compatible license (e.g.
|
||||
MIT, PSF) then it's OK. Code which is GPL or Apache licensed, has no
|
||||
clear license, requires citation or is free for academic use only can't be
|
||||
included in SciPy. Therefore if you copied existing code with such a license
|
||||
or made a direct translation to Python of it, your code can't be included.
|
||||
If you're unsure, please ask on the scipy-dev `mailing list <mailing lists>`_.
|
||||
|
||||
*Why is SciPy under the BSD license and not, say, the GPL?*
|
||||
|
||||
Like Python, SciPy uses a "permissive" open source license, which allows
|
||||
proprietary re-use. While this allows companies to use and modify the software
|
||||
without giving anything back, it is felt that the larger user base results in
|
||||
more contributions overall, and companies often publish their modifications
|
||||
anyway, without being required to. See John Hunter's `BSD pitch`_.
|
||||
|
||||
For more information about SciPy's license, see :ref:`scipy-licensing`.
|
||||
|
||||
|
||||
Maintaining existing code
|
||||
=========================
|
||||
|
||||
The previous section talked specifically about adding new functionality to
|
||||
SciPy. A large part of that discussion also applies to maintenance of existing
|
||||
code. Maintenance means fixing bugs, improving code quality, documenting
|
||||
existing functionality better, adding missing unit tests, adding performance
|
||||
benchmarks, keeping build scripts up-to-date, etc. The SciPy `issue list`_
|
||||
contains all reported bugs, build/documentation issues, etc. Fixing issues
|
||||
helps improve the overall quality of SciPy, and is also a good way
|
||||
of getting familiar with the project. You may also want to fix a bug because
|
||||
you ran into it and need the function in question to work correctly.
|
||||
|
||||
The discussion on code style and unit testing above applies equally to bug
|
||||
fixes. It is usually best to start by writing a unit test that shows the
|
||||
problem, i.e. it should pass but doesn't. Once you have that, you can fix the
|
||||
code so that the test does pass. That should be enough to send a PR for this
|
||||
issue. Unlike when adding new code, discussing this on the mailing list may
|
||||
not be necessary - if the old behavior of the code is clearly incorrect, no one
|
||||
will object to having it fixed. It may be necessary to add some warning or
|
||||
deprecation message for the changed behavior. This should be part of the
|
||||
review process.
|
||||
|
||||
.. note::
|
||||
|
||||
Pull requests that *only* change code style, e.g. fixing some PEP8 issues in
|
||||
a file, are discouraged. Such PRs are often not worth cluttering the git
|
||||
annotate history, and take reviewer time that may be better spent in other ways.
|
||||
Code style cleanups of code that is touched as part of a functional change
|
||||
are fine however.
|
||||
|
||||
|
||||
Reviewing pull requests
|
||||
=======================
|
||||
|
||||
Reviewing open pull requests (PRs) is very welcome, and a valuable way to help
|
||||
increase the speed at which the project moves forward. If you have specific
|
||||
knowledge/experience in a particular area (say "optimization algorithms" or
|
||||
"special functions") then reviewing PRs in that area is especially valuable -
|
||||
sometimes PRs with technical code have to wait for a long time to get merged
|
||||
due to a shortage of appropriate reviewers.
|
||||
|
||||
We encourage everyone to get involved in the review process; it's also a
|
||||
great way to get familiar with the code base. Reviewers should ask
|
||||
themselves some or all of the following questions:
|
||||
|
||||
- Was this change adequately discussed (relevant for new features and changes
|
||||
in existing behavior)?
|
||||
- Is the feature scientifically sound? Algorithms may be known to work based on
|
||||
literature; otherwise, closer look at correctness is valuable.
|
||||
- Is the intended behavior clear under all conditions (e.g. unexpected inputs
|
||||
like empty arrays or nan/inf values)?
|
||||
- Does the code meet the quality, test and documentation expectation outline
|
||||
under `Contributing new code`_?
|
||||
|
||||
If we do not know you yet, consider introducing yourself.
|
||||
|
||||
|
||||
Other ways to contribute
|
||||
========================
|
||||
|
||||
There are many ways to contribute other than writing code.
|
||||
|
||||
Triaging issues (investigating bug reports for validity and possible actions to
|
||||
take) is also a useful activity. SciPy has many hundreds of open issues;
|
||||
closing invalid ones and correctly labeling valid ones (ideally with some first
|
||||
thoughts in a comment) allows prioritizing maintenance work and finding related
|
||||
issues easily when working on an existing function or subpackage.
|
||||
|
||||
Participating in discussions on the scipy-user and scipy-dev `mailing lists`_ is
|
||||
a contribution in itself. Everyone who writes to those lists with a problem or
|
||||
an idea would like to get responses, and writing such responses makes the
|
||||
project and community function better and appear more welcoming.
|
||||
|
||||
The `scipy.org`_ website contains a lot of information on both SciPy the
|
||||
project and SciPy the community, and it can always use a new pair of hands.
|
||||
The sources for the website live in their own separate repo:
|
||||
https://github.com/scipy/scipy.org
|
||||
|
||||
Getting started
|
||||
===============
|
||||
|
||||
Thanks for your interest in contributing to SciPy! If you're interested in
|
||||
contributing code, we hope you'll continue on to the :ref:`contributor-toc`
|
||||
for details on how to set up your development environment, implement your
|
||||
improvements, and submit your first PR!
|
||||
|
||||
.. _scikit-learn: http://scikit-learn.org
|
||||
|
||||
.. _scikit-image: http://scikit-image.org/
|
||||
|
||||
.. _statsmodels: https://www.statsmodels.org/
|
||||
|
||||
.. _testing guidelines: https://docs.scipy.org/doc/numpy/reference/testing.html
|
||||
|
||||
.. _formatted correctly: https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#writing-the-commit-message
|
||||
|
||||
.. _bug report: https://scipy.org/bug-report.html
|
||||
|
||||
.. _PEP8: https://www.python.org/dev/peps/pep-0008/
|
||||
|
||||
.. _pep8 package: https://pypi.python.org/pypi/pep8
|
||||
|
||||
.. _pyflakes: https://pypi.python.org/pypi/pyflakes
|
||||
|
||||
.. _Github help pages: https://help.github.com/articles/set-up-git/
|
||||
|
||||
.. _issue list: https://github.com/scipy/scipy/issues
|
||||
|
||||
.. _Github: https://github.com/scipy/scipy
|
||||
|
||||
.. _scipy.org: https://scipy.org/
|
||||
|
||||
.. _scipy.github.com: https://scipy.github.com/
|
||||
|
||||
.. _scipy.org-new: https://github.com/scipy/scipy.org-new
|
||||
|
||||
.. _documentation wiki: https://docs.scipy.org/scipy/Front%20Page/
|
||||
|
||||
.. _SciPy Central: https://web.archive.org/web/20170520065729/http://central.scipy.org/
|
||||
|
||||
.. _doctest: https://pymotw.com/3/doctest/
|
||||
|
||||
.. _virtualenv: https://virtualenv.pypa.io/
|
||||
|
||||
.. _virtualenvwrapper: https://bitbucket.org/dhellmann/virtualenvwrapper/
|
||||
|
||||
.. _bsd pitch: http://nipy.sourceforge.net/nipy/stable/faq/johns_bsd_pitch.html
|
||||
|
||||
.. _Pytest: https://pytest.org/
|
||||
|
||||
.. _mailing lists: https://www.scipy.org/scipylib/mailing-lists.html
|
||||
|
||||
.. _Spyder: https://www.spyder-ide.org/
|
||||
|
||||
.. _Anaconda SciPy Dev Part I (macOS): https://youtu.be/1rPOSNd0ULI
|
||||
|
||||
.. _Anaconda SciPy Dev Part II (macOS): https://youtu.be/Faz29u5xIZc
|
||||
|
||||
.. _SciPy Development Workflow: https://youtu.be/HgU01gJbzMY
|
||||
Vendored
-255
@@ -1,255 +0,0 @@
|
||||
Building and installing SciPy
|
||||
+++++++++++++++++++++++++++++
|
||||
|
||||
See https://www.scipy.org/install.html
|
||||
|
||||
.. Contents::
|
||||
|
||||
|
||||
INTRODUCTION
|
||||
============
|
||||
|
||||
It is *strongly* recommended that you use either a complete scientific Python
|
||||
distribution or binary packages on your platform if they are available, in
|
||||
particular on Windows and Mac OS X. You should not attempt to build SciPy if
|
||||
you are not familiar with compiling software from sources.
|
||||
|
||||
Recommended distributions are:
|
||||
|
||||
- Enthought Canopy (https://www.enthought.com/products/canopy/)
|
||||
- Anaconda (https://www.anaconda.com)
|
||||
- Python(x,y) (https://python-xy.github.io/)
|
||||
- WinPython (https://winpython.github.io/)
|
||||
|
||||
The rest of this install documentation summarizes how to build Scipy. Note
|
||||
that more extensive (and possibly more up-to-date) build instructions are
|
||||
maintained at https://scipy.github.io/devdocs/building/
|
||||
|
||||
|
||||
PREREQUISITES
|
||||
=============
|
||||
|
||||
SciPy requires the following software installed for your platform:
|
||||
|
||||
1) Python__ >= 3.7
|
||||
|
||||
__ https://www.python.org
|
||||
|
||||
2) NumPy__ >= 1.16.5
|
||||
|
||||
__ https://www.numpy.org/
|
||||
|
||||
If building from source, SciPy also requires:
|
||||
|
||||
3) setuptools__
|
||||
|
||||
__ https://github.com/pypa/setuptools
|
||||
|
||||
4) pybind11__ >= 2.4.3
|
||||
|
||||
__ https://github.com/pybind/pybind11
|
||||
|
||||
5) If you want to build the documentation: Sphinx__ >= 2.4.0 and < 3.1.0
|
||||
|
||||
__ http://www.sphinx-doc.org/
|
||||
|
||||
6) If you want to build SciPy master or other unreleased version from source
|
||||
(Cython-generated C sources are included in official releases):
|
||||
Cython__ >= 0.29.18
|
||||
|
||||
__ http://cython.org/
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Compilers
|
||||
~~~~~~~~~
|
||||
|
||||
There are two ways to build SciPy on Windows:
|
||||
|
||||
1. Use Intel MKL, and Intel compilers or ifort + MSVC. This is what Anaconda
|
||||
and Enthought Canopy use.
|
||||
2. Use MSVC + GFortran with OpenBLAS. This is how the SciPy Windows wheels are
|
||||
built.
|
||||
|
||||
Mac OS X
|
||||
--------
|
||||
|
||||
It is recommended to use GCC or Clang, both work fine. Gcc is available for
|
||||
free when installing Xcode, the developer toolsuite on Mac OS X. You also
|
||||
need a Fortran compiler, which is not included with Xcode: you should use a
|
||||
recent GFortran from an OS X package manager (like Homebrew).
|
||||
|
||||
Please do NOT use GFortran from `hpc.sourceforge.net <http://hpc.sourceforge.net>`_,
|
||||
it is known to generate buggy SciPy binaries.
|
||||
|
||||
You should also use a BLAS/LAPACK library from an OS X package manager.
|
||||
ATLAS, OpenBLAS, and MKL all work.
|
||||
|
||||
As of SciPy version 1.2.0, we do not support compiling against the system
|
||||
Accelerate library for BLAS and LAPACK. It does not support a sufficiently
|
||||
recent LAPACK interface.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Most common distributions include all the dependencies. You will need to
|
||||
install a BLAS/LAPACK (all of ATLAS, OpenBLAS, MKL work fine) including
|
||||
development headers, as well as development headers for Python itself. Those
|
||||
are typically packaged as python-dev.
|
||||
|
||||
|
||||
INSTALLING SCIPY
|
||||
================
|
||||
|
||||
For the latest information, see the website:
|
||||
|
||||
https://www.scipy.org
|
||||
|
||||
|
||||
Development version from Git
|
||||
----------------------------
|
||||
Use the command::
|
||||
|
||||
git clone https://github.com/scipy/scipy.git
|
||||
|
||||
cd scipy
|
||||
git clean -xdf
|
||||
python setup.py install --user
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Type::
|
||||
|
||||
cd scipy/doc
|
||||
make html
|
||||
|
||||
From tarballs
|
||||
-------------
|
||||
Unpack ``SciPy-<version>.tar.gz``, change to the ``SciPy-<version>/``
|
||||
directory, and run::
|
||||
|
||||
pip install . -v --user
|
||||
|
||||
This may take several minutes to half an hour depending on the speed of your
|
||||
computer.
|
||||
|
||||
|
||||
TESTING
|
||||
=======
|
||||
|
||||
To test SciPy after installation (highly recommended), execute in Python::
|
||||
|
||||
>>> import scipy
|
||||
>>> scipy.test()
|
||||
|
||||
To run the full test suite use::
|
||||
|
||||
>>> scipy.test('full')
|
||||
|
||||
If you are upgrading from an older SciPy release, please test your code for any
|
||||
deprecation warnings before and after upgrading to avoid surprises:
|
||||
|
||||
$ python -Wd -c my_code_that_shouldnt_break.py
|
||||
|
||||
Please note that you must have version 1.0 or later of the Pytest test
|
||||
framework installed in order to run the tests. More information about Pytest is
|
||||
available on the website__.
|
||||
|
||||
__ https://pytest.org/
|
||||
|
||||
COMPILER NOTES
|
||||
==============
|
||||
|
||||
You can specify which Fortran compiler to use by using the following
|
||||
install command::
|
||||
|
||||
python setup.py config_fc --fcompiler=<Vendor> install
|
||||
|
||||
To see a valid list of <Vendor> names, run::
|
||||
|
||||
python setup.py config_fc --help-fcompiler
|
||||
|
||||
IMPORTANT: It is highly recommended that all libraries that SciPy uses (e.g.
|
||||
BLAS and ATLAS libraries) are built with the same Fortran compiler. In most
|
||||
cases, if you mix compilers, you will not be able to import SciPy at best, and will have
|
||||
crashes and random results at worst.
|
||||
|
||||
UNINSTALLING
|
||||
============
|
||||
|
||||
When installing with ``python setup.py install`` or a variation on that, you do
|
||||
not get proper uninstall behavior for an older already installed SciPy version.
|
||||
In many cases that's not a problem, but if it turns out to be an issue, you
|
||||
need to manually uninstall it first (remove from e.g. in
|
||||
``/usr/lib/python3.4/site-packages/scipy`` or
|
||||
``$HOME/lib/python3.4/site-packages/scipy``).
|
||||
|
||||
Alternatively, you can use ``pip install . --user`` instead of ``python
|
||||
setup.py install --user`` in order to get reliable uninstall behavior.
|
||||
The downside is that ``pip`` doesn't show you a build log and doesn't support
|
||||
incremental rebuilds (it copies the whole source tree to a tempdir).
|
||||
|
||||
TROUBLESHOOTING
|
||||
===============
|
||||
|
||||
If you experience problems when building/installing/testing SciPy, you
|
||||
can ask help from scipy-user@python.org or scipy-dev@python.org mailing
|
||||
lists. Please include the following information in your message:
|
||||
|
||||
NOTE: You can generate some of the following information (items 1-5,7)
|
||||
in one command::
|
||||
|
||||
python -c 'from numpy.f2py.diagnose import run; run()'
|
||||
|
||||
1) Platform information::
|
||||
|
||||
python -c 'import os, sys; print(os.name, sys.platform)'
|
||||
uname -a
|
||||
OS, its distribution name and version information
|
||||
etc.
|
||||
|
||||
2) Information about C, C++, Fortran compilers/linkers as reported by
|
||||
the compilers when requesting their version information, e.g.,
|
||||
the output of
|
||||
::
|
||||
|
||||
gcc -v
|
||||
g77 --version
|
||||
|
||||
3) Python version::
|
||||
|
||||
python -c 'import sys; print(sys.version)'
|
||||
|
||||
4) NumPy version::
|
||||
|
||||
python -c 'import numpy; print(numpy.__version__)'
|
||||
|
||||
5) ATLAS version, the locations of atlas and lapack libraries, building
|
||||
information if any. If you have ATLAS version 3.3.6 or newer, then
|
||||
give the output of the last command in
|
||||
::
|
||||
|
||||
cd scipy/Lib/linalg
|
||||
python setup_atlas_version.py build_ext --inplace --force
|
||||
python -c 'import atlas_version'
|
||||
|
||||
7) The output of the following commands
|
||||
::
|
||||
|
||||
python INSTALLDIR/numpy/distutils/system_info.py
|
||||
|
||||
where INSTALLDIR is, for example, /usr/lib/python3.4/site-packages/.
|
||||
|
||||
8) Feel free to add any other relevant information.
|
||||
For example, the full output (both stdout and stderr) of the SciPy
|
||||
installation command can be very helpful. Since this output can be
|
||||
rather large, ask before sending it into the mailing list (or
|
||||
better yet, to one of the developers, if asked).
|
||||
|
||||
9) In case of failing to import extension modules, the output of
|
||||
::
|
||||
|
||||
ldd /path/to/ext_module.so
|
||||
|
||||
can be useful.
|
||||
Vendored
-910
@@ -1,910 +0,0 @@
|
||||
Copyright (c) 2001-2002 Enthought, Inc. 2003-2019, SciPy Developers.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following
|
||||
disclaimer in the documentation and/or other materials provided
|
||||
with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived
|
||||
from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
----
|
||||
|
||||
This binary distribution of Scipy also bundles the following software:
|
||||
|
||||
|
||||
Name: OpenBLAS
|
||||
Files: .libs/libopenb*.so
|
||||
Description: bundled as a dynamically linked library
|
||||
Availability: https://github.com/xianyi/OpenBLAS/
|
||||
License: 3-clause BSD
|
||||
Copyright (c) 2011-2014, The OpenBLAS Project
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
3. Neither the name of the OpenBLAS project nor the names of
|
||||
its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written
|
||||
permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
Name: LAPACK
|
||||
Files: .libs/libopenb*.so
|
||||
Description: bundled in OpenBLAS
|
||||
Availability: https://github.com/xianyi/OpenBLAS/
|
||||
License 3-clause BSD
|
||||
Copyright (c) 1992-2013 The University of Tennessee and The University
|
||||
of Tennessee Research Foundation. All rights
|
||||
reserved.
|
||||
Copyright (c) 2000-2013 The University of California Berkeley. All
|
||||
rights reserved.
|
||||
Copyright (c) 2006-2013 The University of Colorado Denver. All rights
|
||||
reserved.
|
||||
|
||||
$COPYRIGHT$
|
||||
|
||||
Additional copyrights may follow
|
||||
|
||||
$HEADER$
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
- Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
- Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer listed
|
||||
in this license in the documentation and/or other materials
|
||||
provided with the distribution.
|
||||
|
||||
- Neither the name of the copyright holders nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
The copyright holders provide no reassurances that the source code
|
||||
provided does not infringe any patent, copyright, or any other
|
||||
intellectual property rights of third parties. The copyright holders
|
||||
disclaim any liability to any recipient for claims brought against
|
||||
recipient by any third party for infringement of that parties
|
||||
intellectual property rights.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
Name: GCC runtime library
|
||||
Files: .libs/libgfortran*.so
|
||||
Description: dynamically linked to files compiled with gcc
|
||||
Availability: https://gcc.gnu.org/viewcvs/gcc/
|
||||
License: GPLv3 + runtime exception
|
||||
Copyright (C) 2002-2017 Free Software Foundation, Inc.
|
||||
|
||||
Libgfortran is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 3, or (at your option)
|
||||
any later version.
|
||||
|
||||
Libgfortran 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 General Public License for more details.
|
||||
|
||||
Under Section 7 of GPL version 3, you are granted additional
|
||||
permissions described in the GCC Runtime Library Exception, version
|
||||
3.1, as published by the Free Software Foundation.
|
||||
|
||||
You should have received a copy of the GNU General Public License and
|
||||
a copy of the GCC Runtime Library Exception along with this program;
|
||||
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
----
|
||||
|
||||
Full text of license texts referred to above follows (that they are
|
||||
listed below does not necessarily imply the conditions apply to the
|
||||
present binary release):
|
||||
|
||||
----
|
||||
|
||||
GCC RUNTIME LIBRARY EXCEPTION
|
||||
|
||||
Version 3.1, 31 March 2009
|
||||
|
||||
Copyright (C) 2009 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
This GCC Runtime Library Exception ("Exception") is an additional
|
||||
permission under section 7 of the GNU General Public License, version
|
||||
3 ("GPLv3"). It applies to a given file (the "Runtime Library") that
|
||||
bears a notice placed by the copyright holder of the file stating that
|
||||
the file is governed by GPLv3 along with this Exception.
|
||||
|
||||
When you use GCC to compile a program, GCC may combine portions of
|
||||
certain GCC header files and runtime libraries with the compiled
|
||||
program. The purpose of this Exception is to allow compilation of
|
||||
non-GPL (including proprietary) programs to use, in this way, the
|
||||
header files and runtime libraries covered by this Exception.
|
||||
|
||||
0. Definitions.
|
||||
|
||||
A file is an "Independent Module" if it either requires the Runtime
|
||||
Library for execution after a Compilation Process, or makes use of an
|
||||
interface provided by the Runtime Library, but is not otherwise based
|
||||
on the Runtime Library.
|
||||
|
||||
"GCC" means a version of the GNU Compiler Collection, with or without
|
||||
modifications, governed by version 3 (or a specified later version) of
|
||||
the GNU General Public License (GPL) with the option of using any
|
||||
subsequent versions published by the FSF.
|
||||
|
||||
"GPL-compatible Software" is software whose conditions of propagation,
|
||||
modification and use would permit combination with GCC in accord with
|
||||
the license of GCC.
|
||||
|
||||
"Target Code" refers to output from any compiler for a real or virtual
|
||||
target processor architecture, in executable form or suitable for
|
||||
input to an assembler, loader, linker and/or execution
|
||||
phase. Notwithstanding that, Target Code does not include data in any
|
||||
format that is used as a compiler intermediate representation, or used
|
||||
for producing a compiler intermediate representation.
|
||||
|
||||
The "Compilation Process" transforms code entirely represented in
|
||||
non-intermediate languages designed for human-written code, and/or in
|
||||
Java Virtual Machine byte code, into Target Code. Thus, for example,
|
||||
use of source code generators and preprocessors need not be considered
|
||||
part of the Compilation Process, since the Compilation Process can be
|
||||
understood as starting with the output of the generators or
|
||||
preprocessors.
|
||||
|
||||
A Compilation Process is "Eligible" if it is done using GCC, alone or
|
||||
with other GPL-compatible software, or if it is done without using any
|
||||
work based on GCC. For example, using non-GPL-compatible Software to
|
||||
optimize any GCC intermediate representations would not qualify as an
|
||||
Eligible Compilation Process.
|
||||
|
||||
1. Grant of Additional Permission.
|
||||
|
||||
You have permission to propagate a work of Target Code formed by
|
||||
combining the Runtime Library with Independent Modules, even if such
|
||||
propagation would otherwise violate the terms of GPLv3, provided that
|
||||
all Target Code was generated by Eligible Compilation Processes. You
|
||||
may then convey such a combination under terms of your choice,
|
||||
consistent with the licensing of the Independent Modules.
|
||||
|
||||
2. No Weakening of GCC Copyleft.
|
||||
|
||||
The availability of this Exception does not imply any general
|
||||
presumption that third-party software is unaffected by the copyleft
|
||||
requirements of the license of GCC.
|
||||
|
||||
----
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
-248
@@ -1,248 +0,0 @@
|
||||
The SciPy repository and source distributions bundle a number of libraries that
|
||||
are compatibly licensed. We list these here.
|
||||
|
||||
Name: Numpydoc
|
||||
Files: doc/sphinxext/numpydoc/*
|
||||
License: 2-clause BSD
|
||||
For details, see doc/sphinxext/LICENSE.txt
|
||||
|
||||
Name: scipy-sphinx-theme
|
||||
Files: doc/scipy-sphinx-theme/*
|
||||
License: 3-clause BSD, PSF and Apache 2.0
|
||||
For details, see doc/sphinxext/LICENSE.txt
|
||||
|
||||
Name: Decorator
|
||||
Files: scipy/_lib/decorator.py
|
||||
License: 2-clause BSD
|
||||
For details, see the header inside scipy/_lib/decorator.py
|
||||
|
||||
Name: ID
|
||||
Files: scipy/linalg/src/id_dist/*
|
||||
License: 3-clause BSD
|
||||
For details, see scipy/linalg/src/id_dist/doc/doc.tex
|
||||
|
||||
Name: L-BFGS-B
|
||||
Files: scipy/optimize/lbfgsb/*
|
||||
License: BSD license
|
||||
For details, see scipy/optimize/lbfgsb/README
|
||||
|
||||
Name: LAPJVsp
|
||||
Files: scipy/sparse/csgraph/_matching.pyx
|
||||
License: 3-clause BSD
|
||||
Copyright 1987-, A. Volgenant/Amsterdam School of Economics,
|
||||
University of Amsterdam
|
||||
|
||||
Distributed under 3-clause BSD license with permission from
|
||||
University of Amsterdam.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
Name: SuperLU
|
||||
Files: scipy/sparse/linalg/dsolve/SuperLU/*
|
||||
License: 3-clause BSD
|
||||
For details, see scipy/sparse/linalg/dsolve/SuperLU/License.txt
|
||||
|
||||
Name: ARPACK
|
||||
Files: scipy/sparse/linalg/eigen/arpack/ARPACK/*
|
||||
License: 3-clause BSD
|
||||
For details, see scipy/sparse/linalg/eigen/arpack/ARPACK/COPYING
|
||||
|
||||
Name: Qhull
|
||||
Files: scipy/spatial/qhull/*
|
||||
License: Qhull license (BSD-like)
|
||||
For details, see scipy/spatial/qhull/COPYING.txt
|
||||
|
||||
Name: Cephes
|
||||
Files: scipy/special/cephes/*
|
||||
License: 3-clause BSD
|
||||
Distributed under 3-clause BSD license with permission from the author,
|
||||
see https://lists.debian.org/debian-legal/2004/12/msg00295.html
|
||||
|
||||
Cephes Math Library Release 2.8: June, 2000
|
||||
Copyright 1984, 1995, 2000 by Stephen L. Moshier
|
||||
|
||||
This software is derived from the Cephes Math Library and is
|
||||
incorporated herein by permission of the author.
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of the <organization> nor the
|
||||
names of its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
|
||||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
Name: Faddeeva
|
||||
Files: scipy/special/Faddeeva.*
|
||||
License: MIT
|
||||
Copyright (c) 2012 Massachusetts Institute of Technology
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
Name: qd
|
||||
Files: scipy/special/cephes/dd_*.[ch]
|
||||
License: modified BSD license ("BSD-LBNL-License.doc")
|
||||
This work was supported by the Director, Office of Science, Division
|
||||
of Mathematical, Information, and Computational Sciences of the
|
||||
U.S. Department of Energy under contract numbers DE-AC03-76SF00098 and
|
||||
DE-AC02-05CH11231.
|
||||
|
||||
Copyright (c) 2003-2009, The Regents of the University of California,
|
||||
through Lawrence Berkeley National Laboratory (subject to receipt of
|
||||
any required approvals from U.S. Dept. of Energy) All rights reserved.
|
||||
|
||||
1. Redistribution and use in source and binary forms, with or
|
||||
without modification, are permitted provided that the following
|
||||
conditions are met:
|
||||
|
||||
(1) Redistributions of source code must retain the copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
(2) Redistributions in binary form must reproduce the copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
(3) Neither the name of the University of California, Lawrence
|
||||
Berkeley National Laboratory, U.S. Dept. of Energy nor the names
|
||||
of its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written
|
||||
permission.
|
||||
|
||||
2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
3. You are under no obligation whatsoever to provide any bug fixes,
|
||||
patches, or upgrades to the features, functionality or performance of
|
||||
the source code ("Enhancements") to anyone; however, if you choose to
|
||||
make your Enhancements available either publicly, or directly to
|
||||
Lawrence Berkeley National Laboratory, without imposing a separate
|
||||
written license agreement for such Enhancements, then you hereby grant
|
||||
the following license: a non-exclusive, royalty-free perpetual license
|
||||
to install, use, modify, prepare derivative works, incorporate into
|
||||
other computer software, distribute, and sublicense such enhancements
|
||||
or derivative works thereof, in binary and source code form.
|
||||
|
||||
Name: pypocketfft
|
||||
Files: scipy/fft/_pocketfft/[pocketfft.h, pypocketfft.cxx]
|
||||
License: 3-Clause BSD
|
||||
For details, see scipy/fft/_pocketfft/LICENSE.md
|
||||
|
||||
Name: uarray
|
||||
Files: scipy/_lib/uarray/*
|
||||
License: 3-Clause BSD
|
||||
For details, see scipy/_lib/uarray/LICENSE
|
||||
|
||||
Name: ampgo
|
||||
Files: benchmarks/benchmarks/go_benchmark_functions/*.py
|
||||
License: MIT
|
||||
Functions for testing global optimizers, forked from the AMPGO project,
|
||||
https://code.google.com/archive/p/ampgo
|
||||
|
||||
Name: pybind11
|
||||
Files: no source files are included, however pybind11 binary artifacts are
|
||||
included with every binary build of SciPy.
|
||||
License:
|
||||
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>, All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
Name: HiGHS
|
||||
Files: scipy/optimize/_highs/*
|
||||
License: MIT
|
||||
For details, see scipy/optimize/_highs/LICENCE
|
||||
|
||||
Name: Boost
|
||||
Files: scipy/_lib/boost/*
|
||||
License: Boost Software License - Version 1.0
|
||||
For details, see scipy/_lib/boost/LICENSE_1_0.txt
|
||||
Vendored
-77
@@ -1,77 +0,0 @@
|
||||
# This file is generated by numpy's setup.py
|
||||
# It contains system_info results at the time of building this package.
|
||||
__all__ = ["get_info","show"]
|
||||
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
extra_dll_dir = os.path.join(os.path.dirname(__file__), '.libs')
|
||||
|
||||
if sys.platform == 'win32' and os.path.isdir(extra_dll_dir):
|
||||
if sys.version_info >= (3, 8):
|
||||
os.add_dll_directory(extra_dll_dir)
|
||||
else:
|
||||
os.environ.setdefault('PATH', '')
|
||||
os.environ['PATH'] += os.pathsep + extra_dll_dir
|
||||
|
||||
lapack_mkl_info={}
|
||||
openblas_lapack_info={'libraries': ['openblas', 'openblas'], 'library_dirs': ['/usr/local/lib'], 'language': 'c', 'define_macros': [('HAVE_CBLAS', None)]}
|
||||
lapack_opt_info={'libraries': ['openblas', 'openblas'], 'library_dirs': ['/usr/local/lib'], 'language': 'c', 'define_macros': [('HAVE_CBLAS', None)]}
|
||||
blas_mkl_info={}
|
||||
blis_info={}
|
||||
openblas_info={'libraries': ['openblas', 'openblas'], 'library_dirs': ['/usr/local/lib'], 'language': 'c', 'define_macros': [('HAVE_CBLAS', None)]}
|
||||
blas_opt_info={'libraries': ['openblas', 'openblas'], 'library_dirs': ['/usr/local/lib'], 'language': 'c', 'define_macros': [('HAVE_CBLAS', None)]}
|
||||
|
||||
def get_info(name):
|
||||
g = globals()
|
||||
return g.get(name, g.get(name + "_info", {}))
|
||||
|
||||
def show():
|
||||
"""
|
||||
Show libraries in the system on which NumPy was built.
|
||||
|
||||
Print information about various resources (libraries, library
|
||||
directories, include directories, etc.) in the system on which
|
||||
NumPy was built.
|
||||
|
||||
See Also
|
||||
--------
|
||||
get_include : Returns the directory containing NumPy C
|
||||
header files.
|
||||
|
||||
Notes
|
||||
-----
|
||||
Classes specifying the information to be printed are defined
|
||||
in the `numpy.distutils.system_info` module.
|
||||
|
||||
Information may include:
|
||||
|
||||
* ``language``: language used to write the libraries (mostly
|
||||
C or f77)
|
||||
* ``libraries``: names of libraries found in the system
|
||||
* ``library_dirs``: directories containing the libraries
|
||||
* ``include_dirs``: directories containing library header files
|
||||
* ``src_dirs``: directories containing library source files
|
||||
* ``define_macros``: preprocessor macros used by
|
||||
``distutils.setup``
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> np.show_config()
|
||||
blas_opt_info:
|
||||
language = c
|
||||
define_macros = [('HAVE_CBLAS', None)]
|
||||
libraries = ['openblas', 'openblas']
|
||||
library_dirs = ['/usr/local/lib']
|
||||
"""
|
||||
for name,info_dict in globals().items():
|
||||
if name[0] == "_" or type(info_dict) is not type({}): continue
|
||||
print(name + ":")
|
||||
if not info_dict:
|
||||
print(" NOT AVAILABLE")
|
||||
for k,v in info_dict.items():
|
||||
v = str(v)
|
||||
if k == "sources" and len(v) > 200:
|
||||
v = v[:60] + " ...\n... " + v[-60:]
|
||||
print(" %s = %s" % (k,v))
|
||||
Vendored
-160
@@ -1,160 +0,0 @@
|
||||
"""
|
||||
SciPy: A scientific computing package for Python
|
||||
================================================
|
||||
|
||||
Documentation is available in the docstrings and
|
||||
online at https://docs.scipy.org.
|
||||
|
||||
Contents
|
||||
--------
|
||||
SciPy imports all the functions from the NumPy namespace, and in
|
||||
addition provides:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
Using any of these subpackages requires an explicit import. For example,
|
||||
``import scipy.cluster``.
|
||||
|
||||
::
|
||||
|
||||
cluster --- Vector Quantization / Kmeans
|
||||
fft --- Discrete Fourier transforms
|
||||
fftpack --- Legacy discrete Fourier transforms
|
||||
integrate --- Integration routines
|
||||
interpolate --- Interpolation Tools
|
||||
io --- Data input and output
|
||||
linalg --- Linear algebra routines
|
||||
linalg.blas --- Wrappers to BLAS library
|
||||
linalg.lapack --- Wrappers to LAPACK library
|
||||
misc --- Various utilities that don't have
|
||||
another home.
|
||||
ndimage --- N-D image package
|
||||
odr --- Orthogonal Distance Regression
|
||||
optimize --- Optimization Tools
|
||||
signal --- Signal Processing Tools
|
||||
signal.windows --- Window functions
|
||||
sparse --- Sparse Matrices
|
||||
sparse.linalg --- Sparse Linear Algebra
|
||||
sparse.linalg.dsolve --- Linear Solvers
|
||||
sparse.linalg.dsolve.umfpack --- :Interface to the UMFPACK library:
|
||||
Conjugate Gradient Method (LOBPCG)
|
||||
sparse.linalg.eigen --- Sparse Eigenvalue Solvers
|
||||
sparse.linalg.eigen.lobpcg --- Locally Optimal Block Preconditioned
|
||||
Conjugate Gradient Method (LOBPCG)
|
||||
spatial --- Spatial data structures and algorithms
|
||||
special --- Special functions
|
||||
stats --- Statistical Functions
|
||||
|
||||
Utility tools
|
||||
-------------
|
||||
::
|
||||
|
||||
test --- Run scipy unittests
|
||||
show_config --- Show scipy build configuration
|
||||
show_numpy_config --- Show numpy build configuration
|
||||
__version__ --- SciPy version string
|
||||
__numpy_version__ --- Numpy version string
|
||||
|
||||
"""
|
||||
|
||||
|
||||
def __dir__():
|
||||
return ['test']
|
||||
|
||||
|
||||
__all__ = __dir__()
|
||||
|
||||
from numpy import show_config as show_numpy_config
|
||||
if show_numpy_config is None:
|
||||
raise ImportError(
|
||||
"Cannot import SciPy when running from NumPy source directory.")
|
||||
from numpy import __version__ as __numpy_version__
|
||||
|
||||
# Import numpy symbols to scipy name space (DEPRECATED)
|
||||
from ._lib.deprecation import _deprecated
|
||||
import numpy as _num
|
||||
linalg = None
|
||||
_msg = ('scipy.{0} is deprecated and will be removed in SciPy 2.0.0, '
|
||||
'use numpy.{0} instead')
|
||||
# deprecate callable objects, skipping classes
|
||||
for _key in _num.__all__:
|
||||
_fun = getattr(_num, _key)
|
||||
if callable(_fun) and not isinstance(_fun, type):
|
||||
_fun = _deprecated(_msg.format(_key))(_fun)
|
||||
globals()[_key] = _fun
|
||||
from numpy.random import rand, randn
|
||||
_msg = ('scipy.{0} is deprecated and will be removed in SciPy 2.0.0, '
|
||||
'use numpy.random.{0} instead')
|
||||
rand = _deprecated(_msg.format('rand'))(rand)
|
||||
randn = _deprecated(_msg.format('randn'))(randn)
|
||||
# fft is especially problematic, so was removed in SciPy 1.6.0
|
||||
from numpy.fft import ifft
|
||||
ifft = _deprecated('scipy.ifft is deprecated and will be removed in SciPy '
|
||||
'2.0.0, use scipy.fft.ifft instead')(ifft)
|
||||
import numpy.lib.scimath as _sci
|
||||
_msg = ('scipy.{0} is deprecated and will be removed in SciPy 2.0.0, '
|
||||
'use numpy.lib.scimath.{0} instead')
|
||||
for _key in _sci.__all__:
|
||||
_fun = getattr(_sci, _key)
|
||||
if callable(_fun):
|
||||
_fun = _deprecated(_msg.format(_key))(_fun)
|
||||
globals()[_key] = _fun
|
||||
|
||||
__all__ += _num.__all__
|
||||
__all__ += ['randn', 'rand', 'ifft']
|
||||
|
||||
del _num
|
||||
# Remove the linalg imported from NumPy so that the scipy.linalg package can be
|
||||
# imported.
|
||||
del linalg
|
||||
__all__.remove('linalg')
|
||||
|
||||
# We first need to detect if we're being called as part of the SciPy
|
||||
# setup procedure itself in a reliable manner.
|
||||
try:
|
||||
__SCIPY_SETUP__
|
||||
except NameError:
|
||||
__SCIPY_SETUP__ = False
|
||||
|
||||
|
||||
if __SCIPY_SETUP__:
|
||||
import sys as _sys
|
||||
_sys.stderr.write('Running from SciPy source directory.\n')
|
||||
del _sys
|
||||
else:
|
||||
try:
|
||||
from scipy.__config__ import show as show_config
|
||||
except ImportError as e:
|
||||
msg = """Error importing SciPy: you cannot import SciPy while
|
||||
being in scipy source directory; please exit the SciPy source
|
||||
tree first and relaunch your Python interpreter."""
|
||||
raise ImportError(msg) from e
|
||||
|
||||
from scipy.version import version as __version__
|
||||
|
||||
# Allow distributors to run custom init code
|
||||
from . import _distributor_init
|
||||
|
||||
from scipy._lib import _pep440
|
||||
# In maintenance branch, change to np_maxversion N+3 if numpy is at N
|
||||
# See setup.py for more details
|
||||
np_minversion = '1.16.5'
|
||||
np_maxversion = '1.23.0'
|
||||
if (_pep440.parse(__numpy_version__) < _pep440.Version(np_minversion) or
|
||||
_pep440.parse(__numpy_version__) >= _pep440.Version(np_maxversion)):
|
||||
import warnings
|
||||
warnings.warn(f"A NumPy version >={np_minversion} and <{np_maxversion}"
|
||||
f" is required for this version of SciPy (detected "
|
||||
f"version {__numpy_version__}",
|
||||
UserWarning)
|
||||
|
||||
del _pep440
|
||||
|
||||
from scipy._lib._ccallback import LowLevelCallable
|
||||
|
||||
from scipy._lib._testutils import PytestTester
|
||||
test = PytestTester(__name__)
|
||||
del PytestTester
|
||||
|
||||
# This makes "from scipy import fft" return scipy.fft, not np.fft
|
||||
del fft
|
||||
-35
@@ -1,35 +0,0 @@
|
||||
import os
|
||||
|
||||
import numpy as np
|
||||
from ._fortran import *
|
||||
from .system_info import combine_dict
|
||||
|
||||
|
||||
# Don't use the deprecated NumPy C API. Define this to a fixed version instead of
|
||||
# NPY_API_VERSION in order not to break compilation for released SciPy versions
|
||||
# when NumPy introduces a new deprecation. Use in setup.py::
|
||||
#
|
||||
# config.add_extension('_name', sources=['source_fname'], **numpy_nodepr_api)
|
||||
#
|
||||
numpy_nodepr_api = dict(define_macros=[("NPY_NO_DEPRECATED_API",
|
||||
"NPY_1_9_API_VERSION")])
|
||||
|
||||
|
||||
def uses_blas64():
|
||||
return (os.environ.get("NPY_USE_BLAS_ILP64", "0") != "0")
|
||||
|
||||
def import_file(folder, module_name):
|
||||
"""Import a file directly, avoiding importing scipy"""
|
||||
import importlib
|
||||
import pathlib
|
||||
|
||||
fname = pathlib.Path(folder) / f'{module_name}.py'
|
||||
spec = importlib.util.spec_from_file_location(module_name, str(fname))
|
||||
module = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(module)
|
||||
return module
|
||||
|
||||
|
||||
from scipy._lib._testutils import PytestTester
|
||||
test = PytestTester(__name__)
|
||||
del PytestTester
|
||||
-444
@@ -1,444 +0,0 @@
|
||||
import re
|
||||
import os
|
||||
import sys
|
||||
from distutils.util import get_platform
|
||||
|
||||
import numpy as np
|
||||
|
||||
from .system_info import combine_dict
|
||||
|
||||
|
||||
__all__ = ['needs_g77_abi_wrapper', 'get_g77_abi_wrappers',
|
||||
'gfortran_legacy_flag_hook', 'blas_ilp64_pre_build_hook',
|
||||
'get_f2py_int64_options', 'generic_pre_build_hook',
|
||||
'write_file_content', 'ilp64_pre_build_hook']
|
||||
|
||||
|
||||
def get_fcompiler_ilp64_flags():
|
||||
"""
|
||||
Dictionary of compiler flags for switching to 8-byte default integer
|
||||
size.
|
||||
"""
|
||||
flags = {
|
||||
'absoft': ['-i8'], # Absoft
|
||||
'compaq': ['-i8'], # Compaq Fortran
|
||||
'compaqv': ['/integer_size:64'], # Compaq Visual Fortran
|
||||
'g95': ['-i8'], # g95
|
||||
'gnu95': ['-fdefault-integer-8'], # GNU gfortran
|
||||
'ibm': ['-qintsize=8'], # IBM XL Fortran
|
||||
'intel': ['-i8'], # Intel Fortran Compiler for 32-bit
|
||||
'intele': ['-i8'], # Intel Fortran Compiler for Itanium
|
||||
'intelem': ['-i8'], # Intel Fortran Compiler for 64-bit
|
||||
'intelv': ['-i8'], # Intel Visual Fortran Compiler for 32-bit
|
||||
'intelev': ['-i8'], # Intel Visual Fortran Compiler for Itanium
|
||||
'intelvem': ['-i8'], # Intel Visual Fortran Compiler for 64-bit
|
||||
'lahey': ['--long'], # Lahey/Fujitsu Fortran 95 Compiler
|
||||
'mips': ['-i8'], # MIPSpro Fortran Compiler
|
||||
'nag': ['-i8'], # NAGWare Fortran 95 compiler
|
||||
'nagfor': ['-i8'], # NAG Fortran compiler
|
||||
'pathf95': ['-i8'], # PathScale Fortran compiler
|
||||
'pg': ['-i8'], # Portland Group Fortran Compiler
|
||||
'flang': ['-i8'], # Portland Group Fortran LLVM Compiler
|
||||
'sun': ['-i8'], # Sun or Forte Fortran 95 Compiler
|
||||
}
|
||||
# No support for this:
|
||||
# - g77
|
||||
# - hpux
|
||||
# Unknown:
|
||||
# - vast
|
||||
return flags
|
||||
|
||||
|
||||
def get_fcompiler_macro_include_flags(path):
|
||||
"""
|
||||
Dictionary of compiler flags for cpp-style preprocessing, with
|
||||
an #include search path, and safety options necessary for macro
|
||||
expansion.
|
||||
"""
|
||||
intel_opts = ['-fpp', '-I' + path]
|
||||
nag_opts = ['-fpp', '-I' + path]
|
||||
|
||||
flags = {
|
||||
'absoft': ['-W132', '-cpp', '-I' + path],
|
||||
'gnu95': ['-cpp', '-ffree-line-length-none',
|
||||
'-ffixed-line-length-none', '-I' + path],
|
||||
'intel': intel_opts,
|
||||
'intele': intel_opts,
|
||||
'intelem': intel_opts,
|
||||
'intelv': intel_opts,
|
||||
'intelev': intel_opts,
|
||||
'intelvem': intel_opts,
|
||||
'lahey': ['-Cpp', '--wide', '-I' + path],
|
||||
'mips': ['-col120', '-I' + path],
|
||||
'nag': nag_opts,
|
||||
'nagfor': nag_opts,
|
||||
'pathf95': ['-ftpp', '-macro-expand', '-I' + path],
|
||||
'flang': ['-Mpreprocess', '-Mextend', '-I' + path],
|
||||
'sun': ['-fpp', '-I' + path],
|
||||
}
|
||||
# No support for this:
|
||||
# - ibm (line length option turns on fixed format)
|
||||
# TODO:
|
||||
# - pg
|
||||
return flags
|
||||
|
||||
|
||||
def uses_mkl(info):
|
||||
r_mkl = re.compile("mkl")
|
||||
libraries = info.get('libraries', '')
|
||||
for library in libraries:
|
||||
if r_mkl.search(library):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def needs_g77_abi_wrapper(info):
|
||||
"""Returns True if g77 ABI wrapper must be used."""
|
||||
try:
|
||||
needs_wrapper = int(os.environ["SCIPY_USE_G77_ABI_WRAPPER"]) != 0
|
||||
except KeyError:
|
||||
needs_wrapper = uses_mkl(info)
|
||||
return needs_wrapper
|
||||
|
||||
|
||||
def get_g77_abi_wrappers(info):
|
||||
"""
|
||||
Returns file names of source files containing Fortran ABI wrapper
|
||||
routines.
|
||||
"""
|
||||
wrapper_sources = []
|
||||
|
||||
path = os.path.abspath(os.path.dirname(__file__))
|
||||
if needs_g77_abi_wrapper(info):
|
||||
wrapper_sources += [
|
||||
os.path.join(path, 'src', 'wrap_g77_abi_f.f'),
|
||||
os.path.join(path, 'src', 'wrap_g77_abi_c.c'),
|
||||
]
|
||||
else:
|
||||
wrapper_sources += [
|
||||
os.path.join(path, 'src', 'wrap_dummy_g77_abi.f'),
|
||||
]
|
||||
return wrapper_sources
|
||||
|
||||
|
||||
def gfortran_legacy_flag_hook(cmd, ext):
|
||||
"""
|
||||
Pre-build hook to add dd gfortran legacy flag -fallow-argument-mismatch
|
||||
"""
|
||||
from .compiler_helper import try_add_flag
|
||||
from distutils.version import LooseVersion
|
||||
|
||||
if isinstance(ext, dict):
|
||||
# build_clib
|
||||
compilers = ((cmd._f_compiler, ext.setdefault('extra_f77_compile_args', [])),
|
||||
(cmd._f_compiler, ext.setdefault('extra_f90_compile_args', [])))
|
||||
else:
|
||||
# build_ext
|
||||
compilers = ((cmd._f77_compiler, ext.extra_f77_compile_args),
|
||||
(cmd._f90_compiler, ext.extra_f90_compile_args))
|
||||
|
||||
for compiler, args in compilers:
|
||||
if compiler is None:
|
||||
continue
|
||||
|
||||
if compiler.compiler_type == "gnu95" and compiler.version >= LooseVersion("10"):
|
||||
try_add_flag(args, compiler, "-fallow-argument-mismatch")
|
||||
|
||||
|
||||
def _get_build_src_dir():
|
||||
plat_specifier = ".{}-{}.{}".format(get_platform(), *sys.version_info[:2])
|
||||
return os.path.join('build', 'src' + plat_specifier)
|
||||
|
||||
|
||||
def get_f2py_int64_options():
|
||||
if np.dtype('i') == np.dtype(np.int64):
|
||||
int64_name = 'int'
|
||||
elif np.dtype('l') == np.dtype(np.int64):
|
||||
int64_name = 'long'
|
||||
elif np.dtype('q') == np.dtype(np.int64):
|
||||
int64_name = 'long_long'
|
||||
else:
|
||||
raise RuntimeError("No 64-bit integer type available in f2py!")
|
||||
|
||||
f2cmap_fn = os.path.join(_get_build_src_dir(), 'int64.f2cmap')
|
||||
text = "{'integer': {'': '%s'}, 'logical': {'': '%s'}}\n" % (
|
||||
int64_name, int64_name)
|
||||
|
||||
write_file_content(f2cmap_fn, text)
|
||||
|
||||
return ['--f2cmap', f2cmap_fn]
|
||||
|
||||
|
||||
def ilp64_pre_build_hook(cmd, ext):
|
||||
"""
|
||||
Pre-build hook for adding Fortran compiler flags that change
|
||||
default integer size to 64-bit.
|
||||
"""
|
||||
fcompiler_flags = get_fcompiler_ilp64_flags()
|
||||
return generic_pre_build_hook(cmd, ext, fcompiler_flags=fcompiler_flags)
|
||||
|
||||
|
||||
def blas_ilp64_pre_build_hook(blas_info):
|
||||
"""
|
||||
Pre-build hook for adding ILP64 BLAS compilation flags, and
|
||||
mangling Fortran source files to rename BLAS/LAPACK symbols when
|
||||
there are symbol suffixes.
|
||||
|
||||
Examples
|
||||
--------
|
||||
::
|
||||
|
||||
from scipy._build_utils import blas_ilp64_pre_build_hook
|
||||
ext = config.add_extension(...)
|
||||
ext._pre_build_hook = blas_ilp64_pre_build_hook(blas_info)
|
||||
|
||||
"""
|
||||
return lambda cmd, ext: _blas_ilp64_pre_build_hook(cmd, ext, blas_info)
|
||||
|
||||
|
||||
def _blas_ilp64_pre_build_hook(cmd, ext, blas_info):
|
||||
# Determine BLAS symbol suffix/prefix, if any
|
||||
macros = dict(blas_info.get('define_macros', []))
|
||||
prefix = macros.get('BLAS_SYMBOL_PREFIX', '')
|
||||
suffix = macros.get('BLAS_SYMBOL_SUFFIX', '')
|
||||
|
||||
if suffix:
|
||||
if not suffix.endswith('_'):
|
||||
# Symbol suffix has to end with '_' to be Fortran-compatible
|
||||
raise RuntimeError("BLAS/LAPACK has incompatible symbol suffix: "
|
||||
"{!r}".format(suffix))
|
||||
|
||||
suffix = suffix[:-1]
|
||||
|
||||
# When symbol prefix/suffix is present, we have to patch sources
|
||||
if prefix or suffix:
|
||||
include_dir = os.path.join(_get_build_src_dir(), 'blas64-include')
|
||||
|
||||
fcompiler_flags = combine_dict(get_fcompiler_ilp64_flags(),
|
||||
get_fcompiler_macro_include_flags(include_dir))
|
||||
|
||||
# Add the include dir for C code
|
||||
if isinstance(ext, dict):
|
||||
ext.setdefault('include_dirs', [])
|
||||
ext['include_dirs'].append(include_dir)
|
||||
else:
|
||||
ext.include_dirs.append(include_dir)
|
||||
|
||||
# Create name-mapping include files
|
||||
include_name_f = 'blas64-prefix-defines.inc'
|
||||
include_name_c = 'blas64-prefix-defines.h'
|
||||
include_fn_f = os.path.join(include_dir, include_name_f)
|
||||
include_fn_c = os.path.join(include_dir, include_name_c)
|
||||
|
||||
text = ""
|
||||
for symbol in get_blas_lapack_symbols():
|
||||
text += '#define {} {}{}_{}\n'.format(symbol, prefix, symbol, suffix)
|
||||
text += '#define {} {}{}_{}\n'.format(symbol.upper(), prefix, symbol, suffix)
|
||||
|
||||
# Code generation may give source codes with mixed-case names
|
||||
for j in (1, 2):
|
||||
s = symbol[:j].lower() + symbol[j:].upper()
|
||||
text += '#define {} {}{}_{}\n'.format(s, prefix, symbol, suffix)
|
||||
s = symbol[:j].upper() + symbol[j:].lower()
|
||||
text += '#define {} {}{}_{}\n'.format(s, prefix, symbol, suffix)
|
||||
|
||||
write_file_content(include_fn_f, text)
|
||||
|
||||
ctext = re.sub(r'^#define (.*) (.*)$', r'#define \1_ \2_', text, flags=re.M)
|
||||
write_file_content(include_fn_c, text + "\n" + ctext)
|
||||
|
||||
# Patch sources to include it
|
||||
def patch_source(filename, old_text):
|
||||
text = '#include "{}"\n'.format(include_name_f)
|
||||
text += old_text
|
||||
return text
|
||||
else:
|
||||
fcompiler_flags = get_fcompiler_ilp64_flags()
|
||||
patch_source = None
|
||||
|
||||
return generic_pre_build_hook(cmd, ext,
|
||||
fcompiler_flags=fcompiler_flags,
|
||||
patch_source_func=patch_source,
|
||||
source_fnpart="_blas64")
|
||||
|
||||
|
||||
def generic_pre_build_hook(cmd, ext, fcompiler_flags, patch_source_func=None,
|
||||
source_fnpart=None):
|
||||
"""
|
||||
Pre-build hook for adding compiler flags and patching sources.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
cmd : distutils.core.Command
|
||||
Hook input. Current distutils command (build_clib or build_ext).
|
||||
ext : dict or numpy.distutils.extension.Extension
|
||||
Hook input. Configuration information for library (dict, build_clib)
|
||||
or extension (numpy.distutils.extension.Extension, build_ext).
|
||||
fcompiler_flags : dict
|
||||
Dictionary of ``{'compiler_name': ['-flag1', ...]}`` containing
|
||||
compiler flags to set.
|
||||
patch_source_func : callable, optional
|
||||
Function patching sources, see `_generic_patch_sources` below.
|
||||
source_fnpart : str, optional
|
||||
String to append to the modified file basename before extension.
|
||||
|
||||
"""
|
||||
is_clib = isinstance(ext, dict)
|
||||
|
||||
if is_clib:
|
||||
build_info = ext
|
||||
del ext
|
||||
|
||||
# build_clib doesn't have separate f77/f90 compilers
|
||||
f77 = cmd._f_compiler
|
||||
f90 = cmd._f_compiler
|
||||
else:
|
||||
f77 = cmd._f77_compiler
|
||||
f90 = cmd._f90_compiler
|
||||
|
||||
# Add compiler flags
|
||||
if is_clib:
|
||||
f77_args = build_info.setdefault('extra_f77_compile_args', [])
|
||||
f90_args = build_info.setdefault('extra_f90_compile_args', [])
|
||||
compilers = [(f77, f77_args), (f90, f90_args)]
|
||||
else:
|
||||
compilers = [(f77, ext.extra_f77_compile_args),
|
||||
(f90, ext.extra_f90_compile_args)]
|
||||
|
||||
for compiler, args in compilers:
|
||||
if compiler is None:
|
||||
continue
|
||||
|
||||
try:
|
||||
flags = fcompiler_flags[compiler.compiler_type]
|
||||
except KeyError as e:
|
||||
raise RuntimeError(
|
||||
"Compiler {!r} is not supported in this "
|
||||
"configuration.".format(compiler.compiler_type)
|
||||
) from e
|
||||
|
||||
args.extend(flag for flag in flags if flag not in args)
|
||||
|
||||
# Mangle sources
|
||||
if patch_source_func is not None:
|
||||
if is_clib:
|
||||
build_info.setdefault('depends', []).extend(build_info['sources'])
|
||||
new_sources = _generic_patch_sources(build_info['sources'], patch_source_func,
|
||||
source_fnpart)
|
||||
build_info['sources'][:] = new_sources
|
||||
else:
|
||||
ext.depends.extend(ext.sources)
|
||||
new_sources = _generic_patch_sources(ext.sources, patch_source_func,
|
||||
source_fnpart)
|
||||
ext.sources[:] = new_sources
|
||||
|
||||
|
||||
def _generic_patch_sources(filenames, patch_source_func, source_fnpart, root_dir=None):
|
||||
"""
|
||||
Patch Fortran sources, creating new source files.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
filenames : list
|
||||
List of Fortran source files to patch.
|
||||
Files not ending in ``.f`` or ``.f90`` are left unaltered.
|
||||
patch_source_func : callable(filename, old_contents) -> new_contents
|
||||
Function to apply to file contents, returning new file contents
|
||||
as a string.
|
||||
source_fnpart : str
|
||||
String to append to the modified file basename before extension.
|
||||
root_dir : str, optional
|
||||
Source root directory. Default: cwd
|
||||
|
||||
Returns
|
||||
-------
|
||||
new_filenames : list
|
||||
List of names of the newly created patched sources.
|
||||
|
||||
"""
|
||||
new_filenames = []
|
||||
|
||||
if root_dir is None:
|
||||
root_dir = os.getcwd()
|
||||
|
||||
root_dir = os.path.abspath(root_dir)
|
||||
src_dir = os.path.join(root_dir, _get_build_src_dir())
|
||||
|
||||
for src in filenames:
|
||||
base, ext = os.path.splitext(os.path.basename(src))
|
||||
|
||||
if ext not in ('.f', '.f90'):
|
||||
new_filenames.append(src)
|
||||
continue
|
||||
|
||||
with open(src, 'r') as fsrc:
|
||||
text = patch_source_func(src, fsrc.read())
|
||||
|
||||
# Generate useful target directory name under src_dir
|
||||
src_path = os.path.abspath(os.path.dirname(src))
|
||||
|
||||
for basedir in [src_dir, root_dir]:
|
||||
if os.path.commonpath([src_path, basedir]) == basedir:
|
||||
rel_path = os.path.relpath(src_path, basedir)
|
||||
break
|
||||
else:
|
||||
raise ValueError(f"{src!r} not under {root_dir!r}")
|
||||
|
||||
dst = os.path.join(src_dir, rel_path, base + source_fnpart + ext)
|
||||
write_file_content(dst, text)
|
||||
|
||||
new_filenames.append(dst)
|
||||
|
||||
return new_filenames
|
||||
|
||||
|
||||
def write_file_content(filename, content):
|
||||
"""
|
||||
Write content to file, but only if it differs from the current one.
|
||||
"""
|
||||
if os.path.isfile(filename):
|
||||
with open(filename, 'r') as f:
|
||||
old_content = f.read()
|
||||
|
||||
if old_content == content:
|
||||
return
|
||||
|
||||
dirname = os.path.dirname(filename)
|
||||
if not os.path.isdir(dirname):
|
||||
os.makedirs(dirname)
|
||||
|
||||
with open(filename, 'w') as f:
|
||||
f.write(content)
|
||||
|
||||
|
||||
def get_blas_lapack_symbols():
|
||||
cached = getattr(get_blas_lapack_symbols, 'cached', None)
|
||||
if cached is not None:
|
||||
return cached
|
||||
|
||||
# Obtain symbol list from Cython Blas/Lapack interface
|
||||
srcdir = os.path.join(os.path.dirname(__file__), os.pardir, 'linalg')
|
||||
|
||||
symbols = []
|
||||
|
||||
# Get symbols from the generated files
|
||||
for fn in ['cython_blas_signatures.txt', 'cython_lapack_signatures.txt']:
|
||||
with open(os.path.join(srcdir, fn), 'r') as f:
|
||||
for line in f:
|
||||
m = re.match(r"^\s*[a-z]+\s+([a-z0-9]+)\(", line)
|
||||
if m:
|
||||
symbols.append(m.group(1))
|
||||
|
||||
# Get the rest from the generator script
|
||||
# (we cannot import it directly here, so use exec)
|
||||
sig_fn = os.path.join(srcdir, '_cython_signature_generator.py')
|
||||
with open(sig_fn, 'r') as f:
|
||||
code = f.read()
|
||||
ns = {'__name__': '<module>'}
|
||||
exec(code, ns)
|
||||
symbols.extend(ns['blas_exclusions'])
|
||||
symbols.extend(ns['lapack_exclusions'])
|
||||
|
||||
get_blas_lapack_symbols.cached = tuple(sorted(set(symbols)))
|
||||
return get_blas_lapack_symbols.cached
|
||||
-134
@@ -1,134 +0,0 @@
|
||||
"""
|
||||
Helpers for detection of compiler features
|
||||
"""
|
||||
import tempfile
|
||||
import os
|
||||
import sys
|
||||
from numpy.distutils.system_info import dict_append
|
||||
|
||||
def try_compile(compiler, code=None, flags=[], ext=None):
|
||||
"""Returns True if the compiler is able to compile the given code"""
|
||||
from distutils.errors import CompileError
|
||||
from numpy.distutils.fcompiler import FCompiler
|
||||
|
||||
if code is None:
|
||||
if isinstance(compiler, FCompiler):
|
||||
code = " program main\n return\n end"
|
||||
else:
|
||||
code = 'int main (int argc, char **argv) { return 0; }'
|
||||
|
||||
ext = ext or compiler.src_extensions[0]
|
||||
|
||||
with tempfile.TemporaryDirectory() as temp_dir:
|
||||
fname = os.path.join(temp_dir, 'main'+ext)
|
||||
with open(fname, 'w') as f:
|
||||
f.write(code)
|
||||
|
||||
try:
|
||||
compiler.compile([fname], output_dir=temp_dir, extra_postargs=flags)
|
||||
except CompileError:
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def has_flag(compiler, flag, ext=None):
|
||||
"""Returns True if the compiler supports the given flag"""
|
||||
return try_compile(compiler, flags=[flag], ext=ext)
|
||||
|
||||
|
||||
def get_cxx_std_flag(compiler):
|
||||
"""Detects compiler flag for c++14, c++11, or None if not detected"""
|
||||
# GNU C compiler documentation uses single dash:
|
||||
# https://gcc.gnu.org/onlinedocs/gcc/Standards.html
|
||||
# but silently understands two dashes, like --std=c++11 too.
|
||||
# Other GCC compatible compilers, like Intel C Compiler on Linux do not.
|
||||
gnu_flags = ['-std=c++14', '-std=c++11']
|
||||
flags_by_cc = {
|
||||
'msvc': ['/std:c++14', None],
|
||||
'intelw': ['/Qstd=c++14', '/Qstd=c++11'],
|
||||
'intelem': ['-std=c++14', '-std=c++11']
|
||||
}
|
||||
flags = flags_by_cc.get(compiler.compiler_type, gnu_flags)
|
||||
|
||||
for flag in flags:
|
||||
if flag is None:
|
||||
return None
|
||||
|
||||
if has_flag(compiler, flag, ext='.cpp'):
|
||||
return flag
|
||||
|
||||
from numpy.distutils import log
|
||||
log.warn('Could not detect c++ standard flag')
|
||||
return None
|
||||
|
||||
|
||||
def get_c_std_flag(compiler):
|
||||
"""Detects compiler flag to enable C99"""
|
||||
gnu_flag = '-std=c99'
|
||||
flag_by_cc = {
|
||||
'msvc': None,
|
||||
'intelw': '/Qstd=c99',
|
||||
'intelem': '-std=c99'
|
||||
}
|
||||
flag = flag_by_cc.get(compiler.compiler_type, gnu_flag)
|
||||
|
||||
if flag is None:
|
||||
return None
|
||||
|
||||
if has_flag(compiler, flag, ext='.c'):
|
||||
return flag
|
||||
|
||||
from numpy.distutils import log
|
||||
log.warn('Could not detect c99 standard flag')
|
||||
return None
|
||||
|
||||
|
||||
def try_add_flag(args, compiler, flag, ext=None):
|
||||
"""Appends flag to the list of arguments if supported by the compiler"""
|
||||
if try_compile(compiler, flags=args+[flag], ext=ext):
|
||||
args.append(flag)
|
||||
|
||||
|
||||
def set_c_flags_hook(build_ext, ext):
|
||||
"""Sets basic compiler flags for compiling C99 code"""
|
||||
std_flag = get_c_std_flag(build_ext.compiler)
|
||||
if std_flag is not None:
|
||||
ext.extra_compile_args.append(std_flag)
|
||||
|
||||
|
||||
def set_cxx_flags_hook(build_ext, ext):
|
||||
"""Sets basic compiler flags for compiling C++11 code"""
|
||||
cc = build_ext._cxx_compiler
|
||||
args = ext.extra_compile_args
|
||||
|
||||
std_flag = get_cxx_std_flag(cc)
|
||||
if std_flag is not None:
|
||||
args.append(std_flag)
|
||||
|
||||
if sys.platform == 'darwin':
|
||||
# Set min macOS version
|
||||
min_macos_flag = '-mmacosx-version-min=10.9'
|
||||
if has_flag(cc, min_macos_flag):
|
||||
args.append(min_macos_flag)
|
||||
ext.extra_link_args.append(min_macos_flag)
|
||||
|
||||
|
||||
def set_cxx_flags_clib_hook(build_clib, build_info):
|
||||
cc = build_clib.compiler
|
||||
new_args = []
|
||||
new_link_args = []
|
||||
|
||||
std_flag = get_cxx_std_flag(cc)
|
||||
if std_flag is not None:
|
||||
new_args.append(std_flag)
|
||||
|
||||
if sys.platform == 'darwin':
|
||||
# Set min macOS version
|
||||
min_macos_flag = '-mmacosx-version-min=10.9'
|
||||
if has_flag(cc, min_macos_flag):
|
||||
new_args.append(min_macos_flag)
|
||||
new_link_args.append(min_macos_flag)
|
||||
|
||||
dict_append(build_info, extra_compiler_args=new_args,
|
||||
extra_link_args=new_link_args)
|
||||
|
||||
-11
@@ -1,11 +0,0 @@
|
||||
|
||||
def configuration(parent_package='', top_path=None):
|
||||
from numpy.distutils.misc_util import Configuration
|
||||
config = Configuration('_build_utils', parent_package, top_path)
|
||||
config.add_data_dir('tests')
|
||||
return config
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
from numpy.distutils.core import setup
|
||||
setup(**configuration(top_path='').todict())
|
||||
-205
@@ -1,205 +0,0 @@
|
||||
import warnings
|
||||
|
||||
import numpy as np
|
||||
import numpy.distutils.system_info
|
||||
|
||||
from numpy.distutils.system_info import (system_info,
|
||||
numpy_info,
|
||||
NotFoundError,
|
||||
BlasNotFoundError,
|
||||
LapackNotFoundError,
|
||||
AtlasNotFoundError,
|
||||
LapackSrcNotFoundError,
|
||||
BlasSrcNotFoundError,
|
||||
dict_append,
|
||||
get_info as old_get_info)
|
||||
|
||||
from scipy._lib import _pep440
|
||||
|
||||
|
||||
def combine_dict(*dicts, **kw):
|
||||
"""
|
||||
Combine Numpy distutils style library configuration dictionaries.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
*dicts
|
||||
Dictionaries of keys. List-valued keys will be concatenated.
|
||||
Otherwise, duplicate keys with different values result to
|
||||
an error. The input arguments are not modified.
|
||||
**kw
|
||||
Keyword arguments are treated as an additional dictionary
|
||||
(the first one, i.e., prepended).
|
||||
|
||||
Returns
|
||||
-------
|
||||
combined
|
||||
Dictionary with combined values.
|
||||
"""
|
||||
new_dict = {}
|
||||
|
||||
for d in (kw,) + dicts:
|
||||
for key, value in d.items():
|
||||
if new_dict.get(key, None) is not None:
|
||||
old_value = new_dict[key]
|
||||
if isinstance(value, (list, tuple)):
|
||||
if isinstance(old_value, (list, tuple)):
|
||||
new_dict[key] = list(old_value) + list(value)
|
||||
continue
|
||||
elif value == old_value:
|
||||
continue
|
||||
|
||||
raise ValueError("Conflicting configuration dicts: {!r} {!r}"
|
||||
"".format(new_dict, d))
|
||||
else:
|
||||
new_dict[key] = value
|
||||
|
||||
return new_dict
|
||||
|
||||
|
||||
if _pep440.parse(np.__version__) >= _pep440.Version("1.15.0.dev"):
|
||||
# For new enough numpy.distutils, the ACCELERATE=None environment
|
||||
# variable in the top-level setup.py is enough, so no need to
|
||||
# customize BLAS detection.
|
||||
get_info = old_get_info
|
||||
else:
|
||||
# For NumPy < 1.15.0, we need overrides.
|
||||
|
||||
def get_info(name, notfound_action=0):
|
||||
# Special case our custom *_opt_info.
|
||||
cls = {'lapack_opt': lapack_opt_info,
|
||||
'blas_opt': blas_opt_info}.get(name.lower())
|
||||
if cls is None:
|
||||
return old_get_info(name, notfound_action)
|
||||
return cls().get_info(notfound_action)
|
||||
|
||||
#
|
||||
# The following is copypaste from numpy.distutils.system_info, with
|
||||
# OSX Accelerate-related parts removed.
|
||||
#
|
||||
|
||||
class lapack_opt_info(system_info):
|
||||
|
||||
notfounderror = LapackNotFoundError
|
||||
|
||||
def calc_info(self):
|
||||
|
||||
lapack_mkl_info = get_info('lapack_mkl')
|
||||
if lapack_mkl_info:
|
||||
self.set_info(**lapack_mkl_info)
|
||||
return
|
||||
|
||||
openblas_info = get_info('openblas_lapack')
|
||||
if openblas_info:
|
||||
self.set_info(**openblas_info)
|
||||
return
|
||||
|
||||
openblas_info = get_info('openblas_clapack')
|
||||
if openblas_info:
|
||||
self.set_info(**openblas_info)
|
||||
return
|
||||
|
||||
atlas_info = get_info('atlas_3_10_threads')
|
||||
if not atlas_info:
|
||||
atlas_info = get_info('atlas_3_10')
|
||||
if not atlas_info:
|
||||
atlas_info = get_info('atlas_threads')
|
||||
if not atlas_info:
|
||||
atlas_info = get_info('atlas')
|
||||
|
||||
need_lapack = 0
|
||||
need_blas = 0
|
||||
info = {}
|
||||
if atlas_info:
|
||||
l = atlas_info.get('define_macros', [])
|
||||
if ('ATLAS_WITH_LAPACK_ATLAS', None) in l \
|
||||
or ('ATLAS_WITHOUT_LAPACK', None) in l:
|
||||
need_lapack = 1
|
||||
info = atlas_info
|
||||
|
||||
else:
|
||||
warnings.warn(AtlasNotFoundError.__doc__, stacklevel=2)
|
||||
need_blas = 1
|
||||
need_lapack = 1
|
||||
dict_append(info, define_macros=[('NO_ATLAS_INFO', 1)])
|
||||
|
||||
if need_lapack:
|
||||
lapack_info = get_info('lapack')
|
||||
#lapack_info = {} ## uncomment for testing
|
||||
if lapack_info:
|
||||
dict_append(info, **lapack_info)
|
||||
else:
|
||||
warnings.warn(LapackNotFoundError.__doc__, stacklevel=2)
|
||||
lapack_src_info = get_info('lapack_src')
|
||||
if not lapack_src_info:
|
||||
warnings.warn(LapackSrcNotFoundError.__doc__, stacklevel=2)
|
||||
return
|
||||
dict_append(info, libraries=[('flapack_src', lapack_src_info)])
|
||||
|
||||
if need_blas:
|
||||
blas_info = get_info('blas')
|
||||
if blas_info:
|
||||
dict_append(info, **blas_info)
|
||||
else:
|
||||
warnings.warn(BlasNotFoundError.__doc__, stacklevel=2)
|
||||
blas_src_info = get_info('blas_src')
|
||||
if not blas_src_info:
|
||||
warnings.warn(BlasSrcNotFoundError.__doc__, stacklevel=2)
|
||||
return
|
||||
dict_append(info, libraries=[('fblas_src', blas_src_info)])
|
||||
|
||||
self.set_info(**info)
|
||||
return
|
||||
|
||||
class blas_opt_info(system_info):
|
||||
|
||||
notfounderror = BlasNotFoundError
|
||||
|
||||
def calc_info(self):
|
||||
|
||||
blas_mkl_info = get_info('blas_mkl')
|
||||
if blas_mkl_info:
|
||||
self.set_info(**blas_mkl_info)
|
||||
return
|
||||
|
||||
blis_info = get_info('blis')
|
||||
if blis_info:
|
||||
self.set_info(**blis_info)
|
||||
return
|
||||
|
||||
openblas_info = get_info('openblas')
|
||||
if openblas_info:
|
||||
self.set_info(**openblas_info)
|
||||
return
|
||||
|
||||
atlas_info = get_info('atlas_3_10_blas_threads')
|
||||
if not atlas_info:
|
||||
atlas_info = get_info('atlas_3_10_blas')
|
||||
if not atlas_info:
|
||||
atlas_info = get_info('atlas_blas_threads')
|
||||
if not atlas_info:
|
||||
atlas_info = get_info('atlas_blas')
|
||||
|
||||
need_blas = 0
|
||||
info = {}
|
||||
if atlas_info:
|
||||
info = atlas_info
|
||||
else:
|
||||
warnings.warn(AtlasNotFoundError.__doc__, stacklevel=2)
|
||||
need_blas = 1
|
||||
dict_append(info, define_macros=[('NO_ATLAS_INFO', 1)])
|
||||
|
||||
if need_blas:
|
||||
blas_info = get_info('blas')
|
||||
if blas_info:
|
||||
dict_append(info, **blas_info)
|
||||
else:
|
||||
warnings.warn(BlasNotFoundError.__doc__, stacklevel=2)
|
||||
blas_src_info = get_info('blas_src')
|
||||
if not blas_src_info:
|
||||
warnings.warn(BlasSrcNotFoundError.__doc__, stacklevel=2)
|
||||
return
|
||||
dict_append(info, libraries=[('fblas_src', blas_src_info)])
|
||||
|
||||
self.set_info(**info)
|
||||
return
|
||||
-32
@@ -1,32 +0,0 @@
|
||||
import sys
|
||||
import os
|
||||
|
||||
from Cython import Tempita as tempita
|
||||
# XXX: If this import ever fails (does it really?), vendor either
|
||||
# cython.tempita or numpy/npy_tempita.
|
||||
|
||||
|
||||
def process_tempita(fromfile):
|
||||
"""Process tempita templated file and write out the result.
|
||||
|
||||
The template file is expected to end in `.c.in` or `.pyx.in`:
|
||||
E.g. processing `template.c.in` generates `template.c`.
|
||||
|
||||
"""
|
||||
if not fromfile.endswith('.in'):
|
||||
raise ValueError("Unexpected extension: %s" % fromfile)
|
||||
|
||||
from_filename = tempita.Template.from_filename
|
||||
template = from_filename(fromfile,
|
||||
encoding=sys.getdefaultencoding())
|
||||
|
||||
content = template.substitute()
|
||||
|
||||
outfile = os.path.splitext(fromfile)[0]
|
||||
with open(outfile, 'w') as f:
|
||||
f.write(content)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
process_tempita(sys.argv[1])
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
import re
|
||||
|
||||
import scipy
|
||||
from numpy.testing import assert_
|
||||
|
||||
|
||||
def test_valid_scipy_version():
|
||||
# Verify that the SciPy version is a valid one (no .post suffix or other
|
||||
# nonsense). See NumPy issue gh-6431 for an issue caused by an invalid
|
||||
# version.
|
||||
version_pattern = r"^[0-9]+\.[0-9]+\.[0-9]+(|a[0-9]|b[0-9]|rc[0-9])"
|
||||
dev_suffix = r"(\.dev0\+.+([0-9a-f]{7}|Unknown))"
|
||||
if scipy.version.release:
|
||||
res = re.match(version_pattern, scipy.__version__)
|
||||
else:
|
||||
res = re.match(version_pattern + dev_suffix, scipy.__version__)
|
||||
|
||||
assert_(res is not None, scipy.__version__)
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
""" Distributor init file
|
||||
|
||||
Distributors: you can add custom code here to support particular distributions
|
||||
of SciPy.
|
||||
|
||||
For example, this is a good place to put any checks for hardware requirements.
|
||||
|
||||
The SciPy standard source distribution will not put code in this file, so you
|
||||
can safely replace this file with your own version.
|
||||
"""
|
||||
Vendored
-14
@@ -1,14 +0,0 @@
|
||||
"""
|
||||
Module containing private utility functions
|
||||
===========================================
|
||||
|
||||
The ``scipy._lib`` namespace is empty (for now). Tests for all
|
||||
utilities in submodules of ``_lib`` can be run with::
|
||||
|
||||
from scipy import _lib
|
||||
_lib.test()
|
||||
|
||||
"""
|
||||
from scipy._lib._testutils import PytestTester
|
||||
test = PytestTester(__name__)
|
||||
del PytestTester
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
'''Helper functions to get location of header files.'''
|
||||
|
||||
import pathlib
|
||||
from typing import Union
|
||||
|
||||
|
||||
def _boost_dir(ret_path: bool = False) -> Union[pathlib.Path, str]:
|
||||
'''Directory where root Boost/ directory lives.'''
|
||||
p = pathlib.Path(__file__).parent / 'boost'
|
||||
return p if ret_path else str(p)
|
||||
Vendored
-225
@@ -1,225 +0,0 @@
|
||||
|
||||
import sys as _sys
|
||||
from keyword import iskeyword as _iskeyword
|
||||
|
||||
|
||||
def _validate_names(typename, field_names, extra_field_names):
|
||||
"""
|
||||
Ensure that all the given names are valid Python identifiers that
|
||||
do not start with '_'. Also check that there are no duplicates
|
||||
among field_names + extra_field_names.
|
||||
"""
|
||||
for name in [typename] + field_names + extra_field_names:
|
||||
if type(name) is not str:
|
||||
raise TypeError('typename and all field names must be strings')
|
||||
if not name.isidentifier():
|
||||
raise ValueError('typename and all field names must be valid '
|
||||
f'identifiers: {name!r}')
|
||||
if _iskeyword(name):
|
||||
raise ValueError('typename and all field names cannot be a '
|
||||
f'keyword: {name!r}')
|
||||
|
||||
seen = set()
|
||||
for name in field_names + extra_field_names:
|
||||
if name.startswith('_'):
|
||||
raise ValueError('Field names cannot start with an underscore: '
|
||||
f'{name!r}')
|
||||
if name in seen:
|
||||
raise ValueError(f'Duplicate field name: {name!r}')
|
||||
seen.add(name)
|
||||
|
||||
|
||||
# Note: This code is adapted from CPython:Lib/collections/__init__.py
|
||||
def _make_tuple_bunch(typename, field_names, extra_field_names=None,
|
||||
module=None):
|
||||
"""
|
||||
Create a namedtuple-like class with additional attributes.
|
||||
|
||||
This function creates a subclass of tuple that acts like a namedtuple
|
||||
and that has additional attributes.
|
||||
|
||||
The additional attributes are listed in `extra_field_names`. The
|
||||
values assigned to these attributes are not part of the tuple.
|
||||
|
||||
The reason this function exists is to allow functions in SciPy
|
||||
that currently return a tuple or a namedtuple to returned objects
|
||||
that have additional attributes, while maintaining backwards
|
||||
compatibility.
|
||||
|
||||
This should only be used to enhance *existing* functions in SciPy.
|
||||
New functions are free to create objects as return values without
|
||||
having to maintain backwards compatibility with an old tuple or
|
||||
namedtuple return value.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
typename : str
|
||||
The name of the type.
|
||||
field_names : list of str
|
||||
List of names of the values to be stored in the tuple. These names
|
||||
will also be attributes of instances, so the values in the tuple
|
||||
can be accessed by indexing or as attributes. At least one name
|
||||
is required. See the Notes for additional restrictions.
|
||||
extra_field_names : list of str, optional
|
||||
List of names of values that will be stored as attributes of the
|
||||
object. See the notes for additional restrictions.
|
||||
|
||||
Returns
|
||||
-------
|
||||
cls : type
|
||||
The new class.
|
||||
|
||||
Notes
|
||||
-----
|
||||
There are restrictions on the names that may be used in `field_names`
|
||||
and `extra_field_names`:
|
||||
|
||||
* The names must be unique--no duplicates allowed.
|
||||
* The names must be valid Python identifiers, and must not begin with
|
||||
an underscore.
|
||||
* The names must not be Python keywords (e.g. 'def', 'and', etc., are
|
||||
not allowed).
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy._lib._bunch import _make_tuple_bunch
|
||||
|
||||
Create a class that acts like a namedtuple with length 2 (with field
|
||||
names `x` and `y`) that will also have the attributes `w` and `beta`:
|
||||
|
||||
>>> Result = _make_tuple_bunch('Result', ['x', 'y'], ['w', 'beta'])
|
||||
|
||||
`Result` is the new class. We call it with keyword arguments to create
|
||||
a new instance with given values.
|
||||
|
||||
>>> result1 = Result(x=1, y=2, w=99, beta=0.5)
|
||||
>>> result1
|
||||
Result(x=1, y=2, w=99, beta=0.5)
|
||||
|
||||
`result1` acts like a tuple of length 2:
|
||||
|
||||
>>> len(result1)
|
||||
2
|
||||
>>> result1[:]
|
||||
(1, 2)
|
||||
|
||||
The values assigned when the instance was created are available as
|
||||
attributes:
|
||||
|
||||
>>> result1.y
|
||||
2
|
||||
>>> result1.beta
|
||||
0.5
|
||||
"""
|
||||
if len(field_names) == 0:
|
||||
raise ValueError('field_names must contain at least one name')
|
||||
|
||||
if extra_field_names is None:
|
||||
extra_field_names = []
|
||||
_validate_names(typename, field_names, extra_field_names)
|
||||
|
||||
typename = _sys.intern(str(typename))
|
||||
field_names = tuple(map(_sys.intern, field_names))
|
||||
extra_field_names = tuple(map(_sys.intern, extra_field_names))
|
||||
|
||||
all_names = field_names + extra_field_names
|
||||
arg_list = ', '.join(field_names)
|
||||
full_list = ', '.join(all_names)
|
||||
repr_fmt = ''.join(('(',
|
||||
', '.join(f'{name}=%({name})r' for name in all_names),
|
||||
')'))
|
||||
tuple_new = tuple.__new__
|
||||
_dict, _tuple, _zip = dict, tuple, zip
|
||||
|
||||
# Create all the named tuple methods to be added to the class namespace
|
||||
|
||||
s = f"""\
|
||||
def __new__(_cls, {arg_list}, **extra_fields):
|
||||
return _tuple_new(_cls, ({arg_list},))
|
||||
|
||||
def __init__(self, {arg_list}, **extra_fields):
|
||||
for key in self._extra_fields:
|
||||
if key not in extra_fields:
|
||||
raise TypeError("missing keyword argument '%s'" % (key,))
|
||||
for key, val in extra_fields.items():
|
||||
if key not in self._extra_fields:
|
||||
raise TypeError("unexpected keyword argument '%s'" % (key,))
|
||||
self.__dict__[key] = val
|
||||
|
||||
def __setattr__(self, key, val):
|
||||
raise AttributeError("can't set attribute %r of class %r"
|
||||
% (key, self.__class__.__name__))
|
||||
"""
|
||||
del arg_list
|
||||
namespace = {'_tuple_new': tuple_new,
|
||||
'__builtins__': dict(TypeError=TypeError,
|
||||
AttributeError=AttributeError),
|
||||
'__name__': f'namedtuple_{typename}'}
|
||||
exec(s, namespace)
|
||||
__new__ = namespace['__new__']
|
||||
__new__.__doc__ = f'Create new instance of {typename}({full_list})'
|
||||
__init__ = namespace['__init__']
|
||||
__init__.__doc__ = f'Instantiate instance of {typename}({full_list})'
|
||||
__setattr__ = namespace['__setattr__']
|
||||
|
||||
def __repr__(self):
|
||||
'Return a nicely formatted representation string'
|
||||
return self.__class__.__name__ + repr_fmt % self._asdict()
|
||||
|
||||
def _asdict(self):
|
||||
'Return a new dict which maps field names to their values.'
|
||||
out = _dict(_zip(self._fields, self))
|
||||
out.update(self.__dict__)
|
||||
return out
|
||||
|
||||
def __getnewargs_ex__(self):
|
||||
'Return self as a plain tuple. Used by copy and pickle.'
|
||||
return _tuple(self), self.__dict__
|
||||
|
||||
# Modify function metadata to help with introspection and debugging
|
||||
for method in (__new__, __repr__, _asdict, __getnewargs_ex__):
|
||||
method.__qualname__ = f'{typename}.{method.__name__}'
|
||||
|
||||
# Build-up the class namespace dictionary
|
||||
# and use type() to build the result class
|
||||
class_namespace = {
|
||||
'__doc__': f'{typename}({full_list})',
|
||||
'_fields': field_names,
|
||||
'__new__': __new__,
|
||||
'__init__': __init__,
|
||||
'__repr__': __repr__,
|
||||
'__setattr__': __setattr__,
|
||||
'_asdict': _asdict,
|
||||
'_extra_fields': extra_field_names,
|
||||
'__getnewargs_ex__': __getnewargs_ex__,
|
||||
}
|
||||
for index, name in enumerate(field_names):
|
||||
doc = _sys.intern(f'Alias for field number {index}')
|
||||
|
||||
def _get(self, index=index):
|
||||
return self[index]
|
||||
class_namespace[name] = property(_get, doc=doc)
|
||||
for name in extra_field_names:
|
||||
doc = _sys.intern(f'Alias for name {name}')
|
||||
|
||||
def _get(self, name=name):
|
||||
return self.__dict__[name]
|
||||
class_namespace[name] = property(_get, doc=doc)
|
||||
|
||||
result = type(typename, (tuple,), class_namespace)
|
||||
|
||||
# For pickling to work, the __module__ variable needs to be set to the
|
||||
# frame where the named tuple is created. Bypass this step in environments
|
||||
# where sys._getframe is not defined (Jython for example) or sys._getframe
|
||||
# is not defined for arguments greater than 0 (IronPython), or where the
|
||||
# user has specified a particular module.
|
||||
if module is None:
|
||||
try:
|
||||
module = _sys._getframe(1).f_globals.get('__name__', '__main__')
|
||||
except (AttributeError, ValueError):
|
||||
pass
|
||||
if module is not None:
|
||||
result.__module__ = module
|
||||
__new__.__module__ = module
|
||||
|
||||
return result
|
||||
Vendored
-227
@@ -1,227 +0,0 @@
|
||||
from . import _ccallback_c
|
||||
|
||||
import ctypes
|
||||
|
||||
PyCFuncPtr = ctypes.CFUNCTYPE(ctypes.c_void_p).__bases__[0]
|
||||
|
||||
ffi = None
|
||||
|
||||
class CData:
|
||||
pass
|
||||
|
||||
def _import_cffi():
|
||||
global ffi, CData
|
||||
|
||||
if ffi is not None:
|
||||
return
|
||||
|
||||
try:
|
||||
import cffi
|
||||
ffi = cffi.FFI()
|
||||
CData = ffi.CData
|
||||
except ImportError:
|
||||
ffi = False
|
||||
|
||||
|
||||
class LowLevelCallable(tuple):
|
||||
"""
|
||||
Low-level callback function.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
function : {PyCapsule, ctypes function pointer, cffi function pointer}
|
||||
Low-level callback function.
|
||||
user_data : {PyCapsule, ctypes void pointer, cffi void pointer}
|
||||
User data to pass on to the callback function.
|
||||
signature : str, optional
|
||||
Signature of the function. If omitted, determined from *function*,
|
||||
if possible.
|
||||
|
||||
Attributes
|
||||
----------
|
||||
function
|
||||
Callback function given.
|
||||
user_data
|
||||
User data given.
|
||||
signature
|
||||
Signature of the function.
|
||||
|
||||
Methods
|
||||
-------
|
||||
from_cython
|
||||
Class method for constructing callables from Cython C-exported
|
||||
functions.
|
||||
|
||||
Notes
|
||||
-----
|
||||
The argument ``function`` can be one of:
|
||||
|
||||
- PyCapsule, whose name contains the C function signature
|
||||
- ctypes function pointer
|
||||
- cffi function pointer
|
||||
|
||||
The signature of the low-level callback must match one of those expected
|
||||
by the routine it is passed to.
|
||||
|
||||
If constructing low-level functions from a PyCapsule, the name of the
|
||||
capsule must be the corresponding signature, in the format::
|
||||
|
||||
return_type (arg1_type, arg2_type, ...)
|
||||
|
||||
For example::
|
||||
|
||||
"void (double)"
|
||||
"double (double, int *, void *)"
|
||||
|
||||
The context of a PyCapsule passed in as ``function`` is used as ``user_data``,
|
||||
if an explicit value for ``user_data`` was not given.
|
||||
|
||||
"""
|
||||
|
||||
# Make the class immutable
|
||||
__slots__ = ()
|
||||
|
||||
def __new__(cls, function, user_data=None, signature=None):
|
||||
# We need to hold a reference to the function & user data,
|
||||
# to prevent them going out of scope
|
||||
item = cls._parse_callback(function, user_data, signature)
|
||||
return tuple.__new__(cls, (item, function, user_data))
|
||||
|
||||
def __repr__(self):
|
||||
return "LowLevelCallable({!r}, {!r})".format(self.function, self.user_data)
|
||||
|
||||
@property
|
||||
def function(self):
|
||||
return tuple.__getitem__(self, 1)
|
||||
|
||||
@property
|
||||
def user_data(self):
|
||||
return tuple.__getitem__(self, 2)
|
||||
|
||||
@property
|
||||
def signature(self):
|
||||
return _ccallback_c.get_capsule_signature(tuple.__getitem__(self, 0))
|
||||
|
||||
def __getitem__(self, idx):
|
||||
raise ValueError()
|
||||
|
||||
@classmethod
|
||||
def from_cython(cls, module, name, user_data=None, signature=None):
|
||||
"""
|
||||
Create a low-level callback function from an exported Cython function.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
module : module
|
||||
Cython module where the exported function resides
|
||||
name : str
|
||||
Name of the exported function
|
||||
user_data : {PyCapsule, ctypes void pointer, cffi void pointer}, optional
|
||||
User data to pass on to the callback function.
|
||||
signature : str, optional
|
||||
Signature of the function. If omitted, determined from *function*.
|
||||
|
||||
"""
|
||||
try:
|
||||
function = module.__pyx_capi__[name]
|
||||
except AttributeError as e:
|
||||
raise ValueError("Given module is not a Cython module with __pyx_capi__ attribute") from e
|
||||
except KeyError as e:
|
||||
raise ValueError("No function {!r} found in __pyx_capi__ of the module".format(name)) from e
|
||||
return cls(function, user_data, signature)
|
||||
|
||||
@classmethod
|
||||
def _parse_callback(cls, obj, user_data=None, signature=None):
|
||||
_import_cffi()
|
||||
|
||||
if isinstance(obj, LowLevelCallable):
|
||||
func = tuple.__getitem__(obj, 0)
|
||||
elif isinstance(obj, PyCFuncPtr):
|
||||
func, signature = _get_ctypes_func(obj, signature)
|
||||
elif isinstance(obj, CData):
|
||||
func, signature = _get_cffi_func(obj, signature)
|
||||
elif _ccallback_c.check_capsule(obj):
|
||||
func = obj
|
||||
else:
|
||||
raise ValueError("Given input is not a callable or a low-level callable (pycapsule/ctypes/cffi)")
|
||||
|
||||
if isinstance(user_data, ctypes.c_void_p):
|
||||
context = _get_ctypes_data(user_data)
|
||||
elif isinstance(user_data, CData):
|
||||
context = _get_cffi_data(user_data)
|
||||
elif user_data is None:
|
||||
context = 0
|
||||
elif _ccallback_c.check_capsule(user_data):
|
||||
context = user_data
|
||||
else:
|
||||
raise ValueError("Given user data is not a valid low-level void* pointer (pycapsule/ctypes/cffi)")
|
||||
|
||||
return _ccallback_c.get_raw_capsule(func, signature, context)
|
||||
|
||||
|
||||
#
|
||||
# ctypes helpers
|
||||
#
|
||||
|
||||
def _get_ctypes_func(func, signature=None):
|
||||
# Get function pointer
|
||||
func_ptr = ctypes.cast(func, ctypes.c_void_p).value
|
||||
|
||||
# Construct function signature
|
||||
if signature is None:
|
||||
signature = _typename_from_ctypes(func.restype) + " ("
|
||||
for j, arg in enumerate(func.argtypes):
|
||||
if j == 0:
|
||||
signature += _typename_from_ctypes(arg)
|
||||
else:
|
||||
signature += ", " + _typename_from_ctypes(arg)
|
||||
signature += ")"
|
||||
|
||||
return func_ptr, signature
|
||||
|
||||
|
||||
def _typename_from_ctypes(item):
|
||||
if item is None:
|
||||
return "void"
|
||||
elif item is ctypes.c_void_p:
|
||||
return "void *"
|
||||
|
||||
name = item.__name__
|
||||
|
||||
pointer_level = 0
|
||||
while name.startswith("LP_"):
|
||||
pointer_level += 1
|
||||
name = name[3:]
|
||||
|
||||
if name.startswith('c_'):
|
||||
name = name[2:]
|
||||
|
||||
if pointer_level > 0:
|
||||
name += " " + "*"*pointer_level
|
||||
|
||||
return name
|
||||
|
||||
|
||||
def _get_ctypes_data(data):
|
||||
# Get voidp pointer
|
||||
return ctypes.cast(data, ctypes.c_void_p).value
|
||||
|
||||
|
||||
#
|
||||
# CFFI helpers
|
||||
#
|
||||
|
||||
def _get_cffi_func(func, signature=None):
|
||||
# Get function pointer
|
||||
func_ptr = ffi.cast('uintptr_t', func)
|
||||
|
||||
# Get signature
|
||||
if signature is None:
|
||||
signature = ffi.getctype(ffi.typeof(func)).replace('(*)', ' ')
|
||||
|
||||
return func_ptr, signature
|
||||
|
||||
|
||||
def _get_cffi_data(data):
|
||||
# Get pointer
|
||||
return ffi.cast('uintptr_t', data)
|
||||
-228
@@ -1,228 +0,0 @@
|
||||
"""
|
||||
Disjoint set data structure
|
||||
"""
|
||||
|
||||
|
||||
class DisjointSet:
|
||||
""" Disjoint set data structure for incremental connectivity queries.
|
||||
|
||||
.. versionadded:: 1.6.0
|
||||
|
||||
Attributes
|
||||
----------
|
||||
n_subsets : int
|
||||
The number of subsets.
|
||||
|
||||
Methods
|
||||
-------
|
||||
add
|
||||
merge
|
||||
connected
|
||||
subset
|
||||
subsets
|
||||
__getitem__
|
||||
|
||||
Notes
|
||||
-----
|
||||
This class implements the disjoint set [1]_, also known as the *union-find*
|
||||
or *merge-find* data structure. The *find* operation (implemented in
|
||||
`__getitem__`) implements the *path halving* variant. The *merge* method
|
||||
implements the *merge by size* variant.
|
||||
|
||||
References
|
||||
----------
|
||||
.. [1] https://en.wikipedia.org/wiki/Disjoint-set_data_structure
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy.cluster.hierarchy import DisjointSet
|
||||
|
||||
Initialize a disjoint set:
|
||||
|
||||
>>> disjoint_set = DisjointSet([1, 2, 3, 'a', 'b'])
|
||||
|
||||
Merge some subsets:
|
||||
|
||||
>>> disjoint_set.merge(1, 2)
|
||||
True
|
||||
>>> disjoint_set.merge(3, 'a')
|
||||
True
|
||||
>>> disjoint_set.merge('a', 'b')
|
||||
True
|
||||
>>> disjoint_set.merge('b', 'b')
|
||||
False
|
||||
|
||||
Find root elements:
|
||||
|
||||
>>> disjoint_set[2]
|
||||
1
|
||||
>>> disjoint_set['b']
|
||||
3
|
||||
|
||||
Test connectivity:
|
||||
|
||||
>>> disjoint_set.connected(1, 2)
|
||||
True
|
||||
>>> disjoint_set.connected(1, 'b')
|
||||
False
|
||||
|
||||
List elements in disjoint set:
|
||||
|
||||
>>> list(disjoint_set)
|
||||
[1, 2, 3, 'a', 'b']
|
||||
|
||||
Get the subset containing 'a':
|
||||
|
||||
>>> disjoint_set.subset('a')
|
||||
{'a', 3, 'b'}
|
||||
|
||||
Get all subsets in the disjoint set:
|
||||
|
||||
>>> disjoint_set.subsets()
|
||||
[{1, 2}, {'a', 3, 'b'}]
|
||||
"""
|
||||
def __init__(self, elements=None):
|
||||
self.n_subsets = 0
|
||||
self._sizes = {}
|
||||
self._parents = {}
|
||||
# _nbrs is a circular linked list which links connected elements.
|
||||
self._nbrs = {}
|
||||
# _indices tracks the element insertion order in `__iter__`.
|
||||
self._indices = {}
|
||||
if elements is not None:
|
||||
for x in elements:
|
||||
self.add(x)
|
||||
|
||||
def __iter__(self):
|
||||
"""Returns an iterator of the elements in the disjoint set.
|
||||
|
||||
Elements are ordered by insertion order.
|
||||
"""
|
||||
return iter(self._indices)
|
||||
|
||||
def __len__(self):
|
||||
return len(self._indices)
|
||||
|
||||
def __contains__(self, x):
|
||||
return x in self._indices
|
||||
|
||||
def __getitem__(self, x):
|
||||
"""Find the root element of `x`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x : hashable object
|
||||
Input element.
|
||||
|
||||
Returns
|
||||
-------
|
||||
root : hashable object
|
||||
Root element of `x`.
|
||||
"""
|
||||
if x not in self._indices:
|
||||
raise KeyError(x)
|
||||
|
||||
# find by "path halving"
|
||||
parents = self._parents
|
||||
while self._indices[x] != self._indices[parents[x]]:
|
||||
parents[x] = parents[parents[x]]
|
||||
x = parents[x]
|
||||
return x
|
||||
|
||||
def add(self, x):
|
||||
"""Add element `x` to disjoint set
|
||||
"""
|
||||
if x in self._indices:
|
||||
return
|
||||
|
||||
self._sizes[x] = 1
|
||||
self._parents[x] = x
|
||||
self._nbrs[x] = x
|
||||
self._indices[x] = len(self._indices)
|
||||
self.n_subsets += 1
|
||||
|
||||
def merge(self, x, y):
|
||||
"""Merge the subsets of `x` and `y`.
|
||||
|
||||
The smaller subset (the child) is merged into the larger subset (the
|
||||
parent). If the subsets are of equal size, the root element which was
|
||||
first inserted into the disjoint set is selected as the parent.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x, y : hashable object
|
||||
Elements to merge.
|
||||
|
||||
Returns
|
||||
-------
|
||||
merged : bool
|
||||
True if `x` and `y` were in disjoint sets, False otherwise.
|
||||
"""
|
||||
xr = self[x]
|
||||
yr = self[y]
|
||||
if self._indices[xr] == self._indices[yr]:
|
||||
return False
|
||||
|
||||
sizes = self._sizes
|
||||
if (sizes[xr], self._indices[yr]) < (sizes[yr], self._indices[xr]):
|
||||
xr, yr = yr, xr
|
||||
self._parents[yr] = xr
|
||||
self._sizes[xr] += self._sizes[yr]
|
||||
self._nbrs[xr], self._nbrs[yr] = self._nbrs[yr], self._nbrs[xr]
|
||||
self.n_subsets -= 1
|
||||
return True
|
||||
|
||||
def connected(self, x, y):
|
||||
"""Test whether `x` and `y` are in the same subset.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x, y : hashable object
|
||||
Elements to test.
|
||||
|
||||
Returns
|
||||
-------
|
||||
result : bool
|
||||
True if `x` and `y` are in the same set, False otherwise.
|
||||
"""
|
||||
return self._indices[self[x]] == self._indices[self[y]]
|
||||
|
||||
def subset(self, x):
|
||||
"""Get the subset containing `x`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x : hashable object
|
||||
Input element.
|
||||
|
||||
Returns
|
||||
-------
|
||||
result : set
|
||||
Subset containing `x`.
|
||||
"""
|
||||
if x not in self._indices:
|
||||
raise KeyError(x)
|
||||
|
||||
result = [x]
|
||||
nxt = self._nbrs[x]
|
||||
while self._indices[nxt] != self._indices[x]:
|
||||
result.append(nxt)
|
||||
nxt = self._nbrs[nxt]
|
||||
return set(result)
|
||||
|
||||
def subsets(self):
|
||||
"""Get all the subsets in the disjoint set.
|
||||
|
||||
Returns
|
||||
-------
|
||||
result : list
|
||||
Subsets in the disjoint set.
|
||||
"""
|
||||
result = []
|
||||
visited = set()
|
||||
for x in self:
|
||||
if x not in visited:
|
||||
xset = self.subset(x)
|
||||
visited.update(xset)
|
||||
result.append(xset)
|
||||
return result
|
||||
Vendored
-105
@@ -1,105 +0,0 @@
|
||||
"""
|
||||
Module for testing automatic garbage collection of objects
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
set_gc_state - enable or disable garbage collection
|
||||
gc_state - context manager for given state of garbage collector
|
||||
assert_deallocated - context manager to check for circular references on object
|
||||
|
||||
"""
|
||||
import weakref
|
||||
import gc
|
||||
|
||||
from contextlib import contextmanager
|
||||
from platform import python_implementation
|
||||
|
||||
__all__ = ['set_gc_state', 'gc_state', 'assert_deallocated']
|
||||
|
||||
|
||||
IS_PYPY = python_implementation() == 'PyPy'
|
||||
|
||||
|
||||
class ReferenceError(AssertionError):
|
||||
pass
|
||||
|
||||
|
||||
def set_gc_state(state):
|
||||
""" Set status of garbage collector """
|
||||
if gc.isenabled() == state:
|
||||
return
|
||||
if state:
|
||||
gc.enable()
|
||||
else:
|
||||
gc.disable()
|
||||
|
||||
|
||||
@contextmanager
|
||||
def gc_state(state):
|
||||
""" Context manager to set state of garbage collector to `state`
|
||||
|
||||
Parameters
|
||||
----------
|
||||
state : bool
|
||||
True for gc enabled, False for disabled
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> with gc_state(False):
|
||||
... assert not gc.isenabled()
|
||||
>>> with gc_state(True):
|
||||
... assert gc.isenabled()
|
||||
"""
|
||||
orig_state = gc.isenabled()
|
||||
set_gc_state(state)
|
||||
yield
|
||||
set_gc_state(orig_state)
|
||||
|
||||
|
||||
@contextmanager
|
||||
def assert_deallocated(func, *args, **kwargs):
|
||||
"""Context manager to check that object is deallocated
|
||||
|
||||
This is useful for checking that an object can be freed directly by
|
||||
reference counting, without requiring gc to break reference cycles.
|
||||
GC is disabled inside the context manager.
|
||||
|
||||
This check is not available on PyPy.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
func : callable
|
||||
Callable to create object to check
|
||||
\\*args : sequence
|
||||
positional arguments to `func` in order to create object to check
|
||||
\\*\\*kwargs : dict
|
||||
keyword arguments to `func` in order to create object to check
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> class C: pass
|
||||
>>> with assert_deallocated(C) as c:
|
||||
... # do something
|
||||
... del c
|
||||
|
||||
>>> class C:
|
||||
... def __init__(self):
|
||||
... self._circular = self # Make circular reference
|
||||
>>> with assert_deallocated(C) as c: #doctest: +IGNORE_EXCEPTION_DETAIL
|
||||
... # do something
|
||||
... del c
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
ReferenceError: Remaining reference(s) to object
|
||||
"""
|
||||
if IS_PYPY:
|
||||
raise RuntimeError("assert_deallocated is unavailable on PyPy")
|
||||
|
||||
with gc_state(False):
|
||||
obj = func(*args, **kwargs)
|
||||
ref = weakref.ref(obj)
|
||||
yield obj
|
||||
del obj
|
||||
if ref() is not None:
|
||||
raise ReferenceError("Remaining reference(s) to object")
|
||||
Vendored
-487
@@ -1,487 +0,0 @@
|
||||
"""Utility to compare pep440 compatible version strings.
|
||||
|
||||
The LooseVersion and StrictVersion classes that distutils provides don't
|
||||
work; they don't recognize anything like alpha/beta/rc/dev versions.
|
||||
"""
|
||||
|
||||
# Copyright (c) Donald Stufft and individual contributors.
|
||||
# All rights reserved.
|
||||
|
||||
# Redistribution and use in source and binary forms, with or without
|
||||
# modification, are permitted provided that the following conditions are met:
|
||||
|
||||
# 1. Redistributions of source code must retain the above copyright notice,
|
||||
# this list of conditions and the following disclaimer.
|
||||
|
||||
# 2. Redistributions in binary form must reproduce the above copyright
|
||||
# notice, this list of conditions and the following disclaimer in the
|
||||
# documentation and/or other materials provided with the distribution.
|
||||
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
# POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
import collections
|
||||
import itertools
|
||||
import re
|
||||
|
||||
|
||||
__all__ = [
|
||||
"parse", "Version", "LegacyVersion", "InvalidVersion", "VERSION_PATTERN",
|
||||
]
|
||||
|
||||
|
||||
# BEGIN packaging/_structures.py
|
||||
|
||||
|
||||
class Infinity:
|
||||
def __repr__(self):
|
||||
return "Infinity"
|
||||
|
||||
def __hash__(self):
|
||||
return hash(repr(self))
|
||||
|
||||
def __lt__(self, other):
|
||||
return False
|
||||
|
||||
def __le__(self, other):
|
||||
return False
|
||||
|
||||
def __eq__(self, other):
|
||||
return isinstance(other, self.__class__)
|
||||
|
||||
def __ne__(self, other):
|
||||
return not isinstance(other, self.__class__)
|
||||
|
||||
def __gt__(self, other):
|
||||
return True
|
||||
|
||||
def __ge__(self, other):
|
||||
return True
|
||||
|
||||
def __neg__(self):
|
||||
return NegativeInfinity
|
||||
|
||||
|
||||
Infinity = Infinity()
|
||||
|
||||
|
||||
class NegativeInfinity:
|
||||
def __repr__(self):
|
||||
return "-Infinity"
|
||||
|
||||
def __hash__(self):
|
||||
return hash(repr(self))
|
||||
|
||||
def __lt__(self, other):
|
||||
return True
|
||||
|
||||
def __le__(self, other):
|
||||
return True
|
||||
|
||||
def __eq__(self, other):
|
||||
return isinstance(other, self.__class__)
|
||||
|
||||
def __ne__(self, other):
|
||||
return not isinstance(other, self.__class__)
|
||||
|
||||
def __gt__(self, other):
|
||||
return False
|
||||
|
||||
def __ge__(self, other):
|
||||
return False
|
||||
|
||||
def __neg__(self):
|
||||
return Infinity
|
||||
|
||||
|
||||
# BEGIN packaging/version.py
|
||||
|
||||
|
||||
NegativeInfinity = NegativeInfinity()
|
||||
|
||||
_Version = collections.namedtuple(
|
||||
"_Version",
|
||||
["epoch", "release", "dev", "pre", "post", "local"],
|
||||
)
|
||||
|
||||
|
||||
def parse(version):
|
||||
"""
|
||||
Parse the given version string and return either a :class:`Version` object
|
||||
or a :class:`LegacyVersion` object depending on if the given version is
|
||||
a valid PEP 440 version or a legacy version.
|
||||
"""
|
||||
try:
|
||||
return Version(version)
|
||||
except InvalidVersion:
|
||||
return LegacyVersion(version)
|
||||
|
||||
|
||||
class InvalidVersion(ValueError):
|
||||
"""
|
||||
An invalid version was found, users should refer to PEP 440.
|
||||
"""
|
||||
|
||||
|
||||
class _BaseVersion:
|
||||
|
||||
def __hash__(self):
|
||||
return hash(self._key)
|
||||
|
||||
def __lt__(self, other):
|
||||
return self._compare(other, lambda s, o: s < o)
|
||||
|
||||
def __le__(self, other):
|
||||
return self._compare(other, lambda s, o: s <= o)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._compare(other, lambda s, o: s == o)
|
||||
|
||||
def __ge__(self, other):
|
||||
return self._compare(other, lambda s, o: s >= o)
|
||||
|
||||
def __gt__(self, other):
|
||||
return self._compare(other, lambda s, o: s > o)
|
||||
|
||||
def __ne__(self, other):
|
||||
return self._compare(other, lambda s, o: s != o)
|
||||
|
||||
def _compare(self, other, method):
|
||||
if not isinstance(other, _BaseVersion):
|
||||
return NotImplemented
|
||||
|
||||
return method(self._key, other._key)
|
||||
|
||||
|
||||
class LegacyVersion(_BaseVersion):
|
||||
|
||||
def __init__(self, version):
|
||||
self._version = str(version)
|
||||
self._key = _legacy_cmpkey(self._version)
|
||||
|
||||
def __str__(self):
|
||||
return self._version
|
||||
|
||||
def __repr__(self):
|
||||
return "<LegacyVersion({0})>".format(repr(str(self)))
|
||||
|
||||
@property
|
||||
def public(self):
|
||||
return self._version
|
||||
|
||||
@property
|
||||
def base_version(self):
|
||||
return self._version
|
||||
|
||||
@property
|
||||
def local(self):
|
||||
return None
|
||||
|
||||
@property
|
||||
def is_prerelease(self):
|
||||
return False
|
||||
|
||||
@property
|
||||
def is_postrelease(self):
|
||||
return False
|
||||
|
||||
|
||||
_legacy_version_component_re = re.compile(
|
||||
r"(\d+ | [a-z]+ | \.| -)", re.VERBOSE,
|
||||
)
|
||||
|
||||
_legacy_version_replacement_map = {
|
||||
"pre": "c", "preview": "c", "-": "final-", "rc": "c", "dev": "@",
|
||||
}
|
||||
|
||||
|
||||
def _parse_version_parts(s):
|
||||
for part in _legacy_version_component_re.split(s):
|
||||
part = _legacy_version_replacement_map.get(part, part)
|
||||
|
||||
if not part or part == ".":
|
||||
continue
|
||||
|
||||
if part[:1] in "0123456789":
|
||||
# pad for numeric comparison
|
||||
yield part.zfill(8)
|
||||
else:
|
||||
yield "*" + part
|
||||
|
||||
# ensure that alpha/beta/candidate are before final
|
||||
yield "*final"
|
||||
|
||||
|
||||
def _legacy_cmpkey(version):
|
||||
# We hardcode an epoch of -1 here. A PEP 440 version can only have an epoch
|
||||
# greater than or equal to 0. This will effectively put the LegacyVersion,
|
||||
# which uses the defacto standard originally implemented by setuptools,
|
||||
# as before all PEP 440 versions.
|
||||
epoch = -1
|
||||
|
||||
# This scheme is taken from pkg_resources.parse_version setuptools prior to
|
||||
# its adoption of the packaging library.
|
||||
parts = []
|
||||
for part in _parse_version_parts(version.lower()):
|
||||
if part.startswith("*"):
|
||||
# remove "-" before a prerelease tag
|
||||
if part < "*final":
|
||||
while parts and parts[-1] == "*final-":
|
||||
parts.pop()
|
||||
|
||||
# remove trailing zeros from each series of numeric parts
|
||||
while parts and parts[-1] == "00000000":
|
||||
parts.pop()
|
||||
|
||||
parts.append(part)
|
||||
parts = tuple(parts)
|
||||
|
||||
return epoch, parts
|
||||
|
||||
|
||||
# Deliberately not anchored to the start and end of the string, to make it
|
||||
# easier for 3rd party code to reuse
|
||||
VERSION_PATTERN = r"""
|
||||
v?
|
||||
(?:
|
||||
(?:(?P<epoch>[0-9]+)!)? # epoch
|
||||
(?P<release>[0-9]+(?:\.[0-9]+)*) # release segment
|
||||
(?P<pre> # pre-release
|
||||
[-_\.]?
|
||||
(?P<pre_l>(a|b|c|rc|alpha|beta|pre|preview))
|
||||
[-_\.]?
|
||||
(?P<pre_n>[0-9]+)?
|
||||
)?
|
||||
(?P<post> # post release
|
||||
(?:-(?P<post_n1>[0-9]+))
|
||||
|
|
||||
(?:
|
||||
[-_\.]?
|
||||
(?P<post_l>post|rev|r)
|
||||
[-_\.]?
|
||||
(?P<post_n2>[0-9]+)?
|
||||
)
|
||||
)?
|
||||
(?P<dev> # dev release
|
||||
[-_\.]?
|
||||
(?P<dev_l>dev)
|
||||
[-_\.]?
|
||||
(?P<dev_n>[0-9]+)?
|
||||
)?
|
||||
)
|
||||
(?:\+(?P<local>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))? # local version
|
||||
"""
|
||||
|
||||
|
||||
class Version(_BaseVersion):
|
||||
|
||||
_regex = re.compile(
|
||||
r"^\s*" + VERSION_PATTERN + r"\s*$",
|
||||
re.VERBOSE | re.IGNORECASE,
|
||||
)
|
||||
|
||||
def __init__(self, version):
|
||||
# Validate the version and parse it into pieces
|
||||
match = self._regex.search(version)
|
||||
if not match:
|
||||
raise InvalidVersion("Invalid version: '{0}'".format(version))
|
||||
|
||||
# Store the parsed out pieces of the version
|
||||
self._version = _Version(
|
||||
epoch=int(match.group("epoch")) if match.group("epoch") else 0,
|
||||
release=tuple(int(i) for i in match.group("release").split(".")),
|
||||
pre=_parse_letter_version(
|
||||
match.group("pre_l"),
|
||||
match.group("pre_n"),
|
||||
),
|
||||
post=_parse_letter_version(
|
||||
match.group("post_l"),
|
||||
match.group("post_n1") or match.group("post_n2"),
|
||||
),
|
||||
dev=_parse_letter_version(
|
||||
match.group("dev_l"),
|
||||
match.group("dev_n"),
|
||||
),
|
||||
local=_parse_local_version(match.group("local")),
|
||||
)
|
||||
|
||||
# Generate a key which will be used for sorting
|
||||
self._key = _cmpkey(
|
||||
self._version.epoch,
|
||||
self._version.release,
|
||||
self._version.pre,
|
||||
self._version.post,
|
||||
self._version.dev,
|
||||
self._version.local,
|
||||
)
|
||||
|
||||
def __repr__(self):
|
||||
return "<Version({0})>".format(repr(str(self)))
|
||||
|
||||
def __str__(self):
|
||||
parts = []
|
||||
|
||||
# Epoch
|
||||
if self._version.epoch != 0:
|
||||
parts.append("{0}!".format(self._version.epoch))
|
||||
|
||||
# Release segment
|
||||
parts.append(".".join(str(x) for x in self._version.release))
|
||||
|
||||
# Pre-release
|
||||
if self._version.pre is not None:
|
||||
parts.append("".join(str(x) for x in self._version.pre))
|
||||
|
||||
# Post-release
|
||||
if self._version.post is not None:
|
||||
parts.append(".post{0}".format(self._version.post[1]))
|
||||
|
||||
# Development release
|
||||
if self._version.dev is not None:
|
||||
parts.append(".dev{0}".format(self._version.dev[1]))
|
||||
|
||||
# Local version segment
|
||||
if self._version.local is not None:
|
||||
parts.append(
|
||||
"+{0}".format(".".join(str(x) for x in self._version.local))
|
||||
)
|
||||
|
||||
return "".join(parts)
|
||||
|
||||
@property
|
||||
def public(self):
|
||||
return str(self).split("+", 1)[0]
|
||||
|
||||
@property
|
||||
def base_version(self):
|
||||
parts = []
|
||||
|
||||
# Epoch
|
||||
if self._version.epoch != 0:
|
||||
parts.append("{0}!".format(self._version.epoch))
|
||||
|
||||
# Release segment
|
||||
parts.append(".".join(str(x) for x in self._version.release))
|
||||
|
||||
return "".join(parts)
|
||||
|
||||
@property
|
||||
def local(self):
|
||||
version_string = str(self)
|
||||
if "+" in version_string:
|
||||
return version_string.split("+", 1)[1]
|
||||
|
||||
@property
|
||||
def is_prerelease(self):
|
||||
return bool(self._version.dev or self._version.pre)
|
||||
|
||||
@property
|
||||
def is_postrelease(self):
|
||||
return bool(self._version.post)
|
||||
|
||||
|
||||
def _parse_letter_version(letter, number):
|
||||
if letter:
|
||||
# We assume there is an implicit 0 in a pre-release if there is
|
||||
# no numeral associated with it.
|
||||
if number is None:
|
||||
number = 0
|
||||
|
||||
# We normalize any letters to their lower-case form
|
||||
letter = letter.lower()
|
||||
|
||||
# We consider some words to be alternate spellings of other words and
|
||||
# in those cases we want to normalize the spellings to our preferred
|
||||
# spelling.
|
||||
if letter == "alpha":
|
||||
letter = "a"
|
||||
elif letter == "beta":
|
||||
letter = "b"
|
||||
elif letter in ["c", "pre", "preview"]:
|
||||
letter = "rc"
|
||||
elif letter in ["rev", "r"]:
|
||||
letter = "post"
|
||||
|
||||
return letter, int(number)
|
||||
if not letter and number:
|
||||
# We assume that if we are given a number but not given a letter,
|
||||
# then this is using the implicit post release syntax (e.g., 1.0-1)
|
||||
letter = "post"
|
||||
|
||||
return letter, int(number)
|
||||
|
||||
|
||||
_local_version_seperators = re.compile(r"[\._-]")
|
||||
|
||||
|
||||
def _parse_local_version(local):
|
||||
"""
|
||||
Takes a string like abc.1.twelve and turns it into ("abc", 1, "twelve").
|
||||
"""
|
||||
if local is not None:
|
||||
return tuple(
|
||||
part.lower() if not part.isdigit() else int(part)
|
||||
for part in _local_version_seperators.split(local)
|
||||
)
|
||||
|
||||
|
||||
def _cmpkey(epoch, release, pre, post, dev, local):
|
||||
# When we compare a release version, we want to compare it with all of the
|
||||
# trailing zeros removed. So we'll use a reverse the list, drop all the now
|
||||
# leading zeros until we come to something non-zero, then take the rest,
|
||||
# re-reverse it back into the correct order, and make it a tuple and use
|
||||
# that for our sorting key.
|
||||
release = tuple(
|
||||
reversed(list(
|
||||
itertools.dropwhile(
|
||||
lambda x: x == 0,
|
||||
reversed(release),
|
||||
)
|
||||
))
|
||||
)
|
||||
|
||||
# We need to "trick" the sorting algorithm to put 1.0.dev0 before 1.0a0.
|
||||
# We'll do this by abusing the pre-segment, but we _only_ want to do this
|
||||
# if there is no pre- or a post-segment. If we have one of those, then
|
||||
# the normal sorting rules will handle this case correctly.
|
||||
if pre is None and post is None and dev is not None:
|
||||
pre = -Infinity
|
||||
# Versions without a pre-release (except as noted above) should sort after
|
||||
# those with one.
|
||||
elif pre is None:
|
||||
pre = Infinity
|
||||
|
||||
# Versions without a post-segment should sort before those with one.
|
||||
if post is None:
|
||||
post = -Infinity
|
||||
|
||||
# Versions without a development segment should sort after those with one.
|
||||
if dev is None:
|
||||
dev = Infinity
|
||||
|
||||
if local is None:
|
||||
# Versions without a local segment should sort before those with one.
|
||||
local = -Infinity
|
||||
else:
|
||||
# Versions with a local segment need that segment parsed to implement
|
||||
# the sorting rules in PEP440.
|
||||
# - Alphanumeric segments sort before numeric segments
|
||||
# - Alphanumeric segments sort lexicographically
|
||||
# - Numeric segments sort numerically
|
||||
# - Shorter versions sort before longer versions when the prefixes
|
||||
# match exactly
|
||||
local = tuple(
|
||||
(i, "") if isinstance(i, int) else (-Infinity, i)
|
||||
for i in local
|
||||
)
|
||||
|
||||
return epoch, release, pre, post, dev, local
|
||||
Vendored
-143
@@ -1,143 +0,0 @@
|
||||
"""
|
||||
Generic test utilities.
|
||||
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
|
||||
|
||||
__all__ = ['PytestTester', 'check_free_memory']
|
||||
|
||||
|
||||
class FPUModeChangeWarning(RuntimeWarning):
|
||||
"""Warning about FPU mode change"""
|
||||
pass
|
||||
|
||||
|
||||
class PytestTester:
|
||||
"""
|
||||
Pytest test runner entry point.
|
||||
"""
|
||||
|
||||
def __init__(self, module_name):
|
||||
self.module_name = module_name
|
||||
|
||||
def __call__(self, label="fast", verbose=1, extra_argv=None, doctests=False,
|
||||
coverage=False, tests=None, parallel=None):
|
||||
import pytest
|
||||
|
||||
module = sys.modules[self.module_name]
|
||||
module_path = os.path.abspath(module.__path__[0])
|
||||
|
||||
pytest_args = ['--showlocals', '--tb=short']
|
||||
|
||||
if doctests:
|
||||
raise ValueError("Doctests not supported")
|
||||
|
||||
if extra_argv:
|
||||
pytest_args += list(extra_argv)
|
||||
|
||||
if verbose and int(verbose) > 1:
|
||||
pytest_args += ["-" + "v"*(int(verbose)-1)]
|
||||
|
||||
if coverage:
|
||||
pytest_args += ["--cov=" + module_path]
|
||||
|
||||
if label == "fast":
|
||||
pytest_args += ["-m", "not slow"]
|
||||
elif label != "full":
|
||||
pytest_args += ["-m", label]
|
||||
|
||||
if tests is None:
|
||||
tests = [self.module_name]
|
||||
|
||||
if parallel is not None and parallel > 1:
|
||||
if _pytest_has_xdist():
|
||||
pytest_args += ['-n', str(parallel)]
|
||||
else:
|
||||
import warnings
|
||||
warnings.warn('Could not run tests in parallel because '
|
||||
'pytest-xdist plugin is not available.')
|
||||
|
||||
pytest_args += ['--pyargs'] + list(tests)
|
||||
|
||||
try:
|
||||
code = pytest.main(pytest_args)
|
||||
except SystemExit as exc:
|
||||
code = exc.code
|
||||
|
||||
return (code == 0)
|
||||
|
||||
|
||||
def _pytest_has_xdist():
|
||||
"""
|
||||
Check if the pytest-xdist plugin is installed, providing parallel tests
|
||||
"""
|
||||
# Check xdist exists without importing, otherwise pytests emits warnings
|
||||
from importlib.util import find_spec
|
||||
return find_spec('xdist') is not None
|
||||
|
||||
|
||||
def check_free_memory(free_mb):
|
||||
"""
|
||||
Check *free_mb* of memory is available, otherwise do pytest.skip
|
||||
"""
|
||||
import pytest
|
||||
|
||||
try:
|
||||
mem_free = _parse_size(os.environ['SCIPY_AVAILABLE_MEM'])
|
||||
msg = '{0} MB memory required, but environment SCIPY_AVAILABLE_MEM={1}'.format(
|
||||
free_mb, os.environ['SCIPY_AVAILABLE_MEM'])
|
||||
except KeyError:
|
||||
mem_free = _get_mem_available()
|
||||
if mem_free is None:
|
||||
pytest.skip("Could not determine available memory; set SCIPY_AVAILABLE_MEM "
|
||||
"variable to free memory in MB to run the test.")
|
||||
msg = '{0} MB memory required, but {1} MB available'.format(
|
||||
free_mb, mem_free/1e6)
|
||||
|
||||
if mem_free < free_mb * 1e6:
|
||||
pytest.skip(msg)
|
||||
|
||||
|
||||
def _parse_size(size_str):
|
||||
suffixes = {'': 1e6,
|
||||
'b': 1.0,
|
||||
'k': 1e3, 'M': 1e6, 'G': 1e9, 'T': 1e12,
|
||||
'kb': 1e3, 'Mb': 1e6, 'Gb': 1e9, 'Tb': 1e12,
|
||||
'kib': 1024.0, 'Mib': 1024.0**2, 'Gib': 1024.0**3, 'Tib': 1024.0**4}
|
||||
m = re.match(r'^\s*(\d+)\s*({0})\s*$'.format('|'.join(suffixes.keys())),
|
||||
size_str,
|
||||
re.I)
|
||||
if not m or m.group(2) not in suffixes:
|
||||
raise ValueError("Invalid size string")
|
||||
|
||||
return float(m.group(1)) * suffixes[m.group(2)]
|
||||
|
||||
|
||||
def _get_mem_available():
|
||||
"""
|
||||
Get information about memory available, not counting swap.
|
||||
"""
|
||||
try:
|
||||
import psutil
|
||||
return psutil.virtual_memory().available
|
||||
except (ImportError, AttributeError):
|
||||
pass
|
||||
|
||||
if sys.platform.startswith('linux'):
|
||||
info = {}
|
||||
with open('/proc/meminfo', 'r') as f:
|
||||
for line in f:
|
||||
p = line.split()
|
||||
info[p[0].strip(':').lower()] = float(p[1]) * 1e3
|
||||
|
||||
if 'memavailable' in info:
|
||||
# Linux >= 3.14
|
||||
return info['memavailable']
|
||||
else:
|
||||
return info['memfree'] + info['cached']
|
||||
|
||||
return None
|
||||
-58
@@ -1,58 +0,0 @@
|
||||
import threading
|
||||
|
||||
import scipy._lib.decorator
|
||||
|
||||
|
||||
__all__ = ['ReentrancyError', 'ReentrancyLock', 'non_reentrant']
|
||||
|
||||
|
||||
class ReentrancyError(RuntimeError):
|
||||
pass
|
||||
|
||||
|
||||
class ReentrancyLock:
|
||||
"""
|
||||
Threading lock that raises an exception for reentrant calls.
|
||||
|
||||
Calls from different threads are serialized, and nested calls from the
|
||||
same thread result to an error.
|
||||
|
||||
The object can be used as a context manager or to decorate functions
|
||||
via the decorate() method.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, err_msg):
|
||||
self._rlock = threading.RLock()
|
||||
self._entered = False
|
||||
self._err_msg = err_msg
|
||||
|
||||
def __enter__(self):
|
||||
self._rlock.acquire()
|
||||
if self._entered:
|
||||
self._rlock.release()
|
||||
raise ReentrancyError(self._err_msg)
|
||||
self._entered = True
|
||||
|
||||
def __exit__(self, type, value, traceback):
|
||||
self._entered = False
|
||||
self._rlock.release()
|
||||
|
||||
def decorate(self, func):
|
||||
def caller(func, *a, **kw):
|
||||
with self:
|
||||
return func(*a, **kw)
|
||||
return scipy._lib.decorator.decorate(func, caller)
|
||||
|
||||
|
||||
def non_reentrant(err_msg=None):
|
||||
"""
|
||||
Decorate a function with a threading lock and prevent reentrant calls.
|
||||
"""
|
||||
def decorator(func):
|
||||
msg = err_msg
|
||||
if msg is None:
|
||||
msg = "%s is not re-entrant" % func.__name__
|
||||
lock = ReentrancyLock(msg)
|
||||
return lock.decorate(func)
|
||||
return decorator
|
||||
Vendored
-86
@@ -1,86 +0,0 @@
|
||||
''' Contexts for *with* statement providing temporary directories
|
||||
'''
|
||||
import os
|
||||
from contextlib import contextmanager
|
||||
from shutil import rmtree
|
||||
from tempfile import mkdtemp
|
||||
|
||||
|
||||
@contextmanager
|
||||
def tempdir():
|
||||
"""Create and return a temporary directory. This has the same
|
||||
behavior as mkdtemp but can be used as a context manager.
|
||||
|
||||
Upon exiting the context, the directory and everything contained
|
||||
in it are removed.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> import os
|
||||
>>> with tempdir() as tmpdir:
|
||||
... fname = os.path.join(tmpdir, 'example_file.txt')
|
||||
... with open(fname, 'wt') as fobj:
|
||||
... _ = fobj.write('a string\\n')
|
||||
>>> os.path.exists(tmpdir)
|
||||
False
|
||||
"""
|
||||
d = mkdtemp()
|
||||
yield d
|
||||
rmtree(d)
|
||||
|
||||
|
||||
@contextmanager
|
||||
def in_tempdir():
|
||||
''' Create, return, and change directory to a temporary directory
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> import os
|
||||
>>> my_cwd = os.getcwd()
|
||||
>>> with in_tempdir() as tmpdir:
|
||||
... _ = open('test.txt', 'wt').write('some text')
|
||||
... assert os.path.isfile('test.txt')
|
||||
... assert os.path.isfile(os.path.join(tmpdir, 'test.txt'))
|
||||
>>> os.path.exists(tmpdir)
|
||||
False
|
||||
>>> os.getcwd() == my_cwd
|
||||
True
|
||||
'''
|
||||
pwd = os.getcwd()
|
||||
d = mkdtemp()
|
||||
os.chdir(d)
|
||||
yield d
|
||||
os.chdir(pwd)
|
||||
rmtree(d)
|
||||
|
||||
|
||||
@contextmanager
|
||||
def in_dir(dir=None):
|
||||
""" Change directory to given directory for duration of ``with`` block
|
||||
|
||||
Useful when you want to use `in_tempdir` for the final test, but
|
||||
you are still debugging. For example, you may want to do this in the end:
|
||||
|
||||
>>> with in_tempdir() as tmpdir:
|
||||
... # do something complicated which might break
|
||||
... pass
|
||||
|
||||
But, indeed, the complicated thing does break, and meanwhile, the
|
||||
``in_tempdir`` context manager wiped out the directory with the
|
||||
temporary files that you wanted for debugging. So, while debugging, you
|
||||
replace with something like:
|
||||
|
||||
>>> with in_dir() as tmpdir: # Use working directory by default
|
||||
... # do something complicated which might break
|
||||
... pass
|
||||
|
||||
You can then look at the temporary file outputs to debug what is happening,
|
||||
fix, and finally replace ``in_dir`` with ``in_tempdir`` again.
|
||||
"""
|
||||
cwd = os.getcwd()
|
||||
if dir is None:
|
||||
yield cwd
|
||||
return
|
||||
os.chdir(dir)
|
||||
yield dir
|
||||
os.chdir(cwd)
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
BSD 3-Clause License
|
||||
|
||||
Copyright (c) 2018, Quansight-Labs
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
-117
@@ -1,117 +0,0 @@
|
||||
"""
|
||||
.. note::
|
||||
If you are looking for overrides for NumPy-specific methods, see the
|
||||
documentation for :obj:`unumpy`. This page explains how to write
|
||||
back-ends and multimethods.
|
||||
|
||||
``uarray`` is built around a back-end protocol and overridable multimethods.
|
||||
It is necessary to define multimethods for back-ends to be able to override them.
|
||||
See the documentation of :obj:`generate_multimethod` on how to write multimethods.
|
||||
|
||||
|
||||
|
||||
Let's start with the simplest:
|
||||
|
||||
``__ua_domain__`` defines the back-end *domain*. The domain consists of period-
|
||||
separated string consisting of the modules you extend plus the submodule. For
|
||||
example, if a submodule ``module2.submodule`` extends ``module1``
|
||||
(i.e., it exposes dispatchables marked as types available in ``module1``),
|
||||
then the domain string should be ``"module1.module2.submodule"``.
|
||||
|
||||
|
||||
For the purpose of this demonstration, we'll be creating an object and setting
|
||||
its attributes directly. However, note that you can use a module or your own type
|
||||
as a backend as well.
|
||||
|
||||
>>> class Backend: pass
|
||||
>>> be = Backend()
|
||||
>>> be.__ua_domain__ = "ua_examples"
|
||||
|
||||
It might be useful at this point to sidetrack to the documentation of
|
||||
:obj:`generate_multimethod` to find out how to generate a multimethod
|
||||
overridable by :obj:`uarray`. Needless to say, writing a backend and
|
||||
creating multimethods are mostly orthogonal activities, and knowing
|
||||
one doesn't necessarily require knowledge of the other, although it
|
||||
is certainly helpful. We expect core API designers/specifiers to write the
|
||||
multimethods, and implementors to override them. But, as is often the case,
|
||||
similar people write both.
|
||||
|
||||
Without further ado, here's an example multimethod:
|
||||
|
||||
>>> import uarray as ua
|
||||
>>> from uarray import Dispatchable
|
||||
>>> def override_me(a, b):
|
||||
... return Dispatchable(a, int),
|
||||
>>> def override_replacer(args, kwargs, dispatchables):
|
||||
... return (dispatchables[0], args[1]), {}
|
||||
>>> overridden_me = ua.generate_multimethod(
|
||||
... override_me, override_replacer, "ua_examples"
|
||||
... )
|
||||
|
||||
Next comes the part about overriding the multimethod. This requires
|
||||
the ``__ua_function__`` protocol, and the ``__ua_convert__``
|
||||
protocol. The ``__ua_function__`` protocol has the signature
|
||||
``(method, args, kwargs)`` where ``method`` is the passed
|
||||
multimethod, ``args``/``kwargs`` specify the arguments and ``dispatchables``
|
||||
is the list of converted dispatchables passed in.
|
||||
|
||||
>>> def __ua_function__(method, args, kwargs):
|
||||
... return method.__name__, args, kwargs
|
||||
>>> be.__ua_function__ = __ua_function__
|
||||
|
||||
The other protocol of interest is the ``__ua_convert__`` protocol. It has the
|
||||
signature ``(dispatchables, coerce)``. When ``coerce`` is ``False``, conversion
|
||||
between the formats should ideally be an ``O(1)`` operation, but it means that
|
||||
no memory copying should be involved, only views of the existing data.
|
||||
|
||||
>>> def __ua_convert__(dispatchables, coerce):
|
||||
... for d in dispatchables:
|
||||
... if d.type is int:
|
||||
... if coerce and d.coercible:
|
||||
... yield str(d.value)
|
||||
... else:
|
||||
... yield d.value
|
||||
>>> be.__ua_convert__ = __ua_convert__
|
||||
|
||||
Now that we have defined the backend, the next thing to do is to call the multimethod.
|
||||
|
||||
>>> with ua.set_backend(be):
|
||||
... overridden_me(1, "2")
|
||||
('override_me', (1, '2'), {})
|
||||
|
||||
Note that the marked type has no effect on the actual type of the passed object.
|
||||
We can also coerce the type of the input.
|
||||
|
||||
>>> with ua.set_backend(be, coerce=True):
|
||||
... overridden_me(1, "2")
|
||||
... overridden_me(1.0, "2")
|
||||
('override_me', ('1', '2'), {})
|
||||
('override_me', ('1.0', '2'), {})
|
||||
|
||||
Another feature is that if you remove ``__ua_convert__``, the arguments are not
|
||||
converted at all and it's up to the backend to handle that.
|
||||
|
||||
>>> del be.__ua_convert__
|
||||
>>> with ua.set_backend(be):
|
||||
... overridden_me(1, "2")
|
||||
('override_me', (1, '2'), {})
|
||||
|
||||
You also have the option to return ``NotImplemented``, in which case processing moves on
|
||||
to the next back-end, which, in this case, doesn't exist. The same applies to
|
||||
``__ua_convert__``.
|
||||
|
||||
>>> be.__ua_function__ = lambda *a, **kw: NotImplemented
|
||||
>>> with ua.set_backend(be):
|
||||
... overridden_me(1, "2")
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
uarray.backend.BackendNotImplementedError: ...
|
||||
|
||||
The last possibility is if we don't have ``__ua_convert__``, in which case the job is left
|
||||
up to ``__ua_function__``, but putting things back into arrays after conversion will not be
|
||||
possible.
|
||||
"""
|
||||
|
||||
from ._backend import *
|
||||
|
||||
__version__ = '0.5.1+49.g4c3f1d7.scipy'
|
||||
-425
@@ -1,425 +0,0 @@
|
||||
import typing
|
||||
import inspect
|
||||
import functools
|
||||
from . import _uarray # type: ignore
|
||||
import copyreg # type: ignore
|
||||
import atexit
|
||||
import pickle
|
||||
|
||||
ArgumentExtractorType = typing.Callable[..., typing.Tuple["Dispatchable", ...]]
|
||||
ArgumentReplacerType = typing.Callable[
|
||||
[typing.Tuple, typing.Dict, typing.Tuple], typing.Tuple[typing.Tuple, typing.Dict]
|
||||
]
|
||||
|
||||
from ._uarray import ( # type: ignore
|
||||
BackendNotImplementedError,
|
||||
_Function,
|
||||
_SkipBackendContext,
|
||||
_SetBackendContext,
|
||||
)
|
||||
|
||||
__all__ = [
|
||||
"set_backend",
|
||||
"set_global_backend",
|
||||
"skip_backend",
|
||||
"register_backend",
|
||||
"clear_backends",
|
||||
"create_multimethod",
|
||||
"generate_multimethod",
|
||||
"_Function",
|
||||
"BackendNotImplementedError",
|
||||
"Dispatchable",
|
||||
"wrap_single_convertor",
|
||||
"all_of_type",
|
||||
"mark_as",
|
||||
]
|
||||
|
||||
|
||||
def unpickle_function(mod_name, qname):
|
||||
import importlib
|
||||
|
||||
try:
|
||||
module = importlib.import_module(mod_name)
|
||||
func = getattr(module, qname)
|
||||
return func
|
||||
except (ImportError, AttributeError) as e:
|
||||
from pickle import UnpicklingError
|
||||
|
||||
raise UnpicklingError from e
|
||||
|
||||
|
||||
def pickle_function(func):
|
||||
mod_name = getattr(func, "__module__", None)
|
||||
qname = getattr(func, "__qualname__", None)
|
||||
|
||||
try:
|
||||
test = unpickle_function(mod_name, qname)
|
||||
except pickle.UnpicklingError:
|
||||
test = None
|
||||
|
||||
if test is not func:
|
||||
raise pickle.PicklingError(
|
||||
"Can't pickle {}: it's not the same object as {}".format(func, test)
|
||||
)
|
||||
|
||||
return unpickle_function, (mod_name, qname)
|
||||
|
||||
|
||||
copyreg.pickle(_Function, pickle_function)
|
||||
atexit.register(_uarray.clear_all_globals)
|
||||
|
||||
|
||||
def create_multimethod(*args, **kwargs):
|
||||
"""
|
||||
Creates a decorator for generating multimethods.
|
||||
|
||||
This function creates a decorator that can be used with an argument
|
||||
extractor in order to generate a multimethod. Other than for the
|
||||
argument extractor, all arguments are passed on to
|
||||
:obj:`generate_multimethod`.
|
||||
|
||||
See Also
|
||||
--------
|
||||
generate_multimethod : Generates a multimethod.
|
||||
"""
|
||||
|
||||
def wrapper(a):
|
||||
return generate_multimethod(a, *args, **kwargs)
|
||||
|
||||
return wrapper
|
||||
|
||||
|
||||
def generate_multimethod(
|
||||
argument_extractor: ArgumentExtractorType,
|
||||
argument_replacer: ArgumentReplacerType,
|
||||
domain: str,
|
||||
default: typing.Optional[typing.Callable] = None
|
||||
):
|
||||
"""
|
||||
Generates a multimethod.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
argument_extractor : ArgumentExtractorType
|
||||
A callable which extracts the dispatchable arguments. Extracted arguments
|
||||
should be marked by the :obj:`Dispatchable` class. It has the same signature
|
||||
as the desired multimethod.
|
||||
argument_replacer : ArgumentReplacerType
|
||||
A callable with the signature (args, kwargs, dispatchables), which should also
|
||||
return an (args, kwargs) pair with the dispatchables replaced inside the args/kwargs.
|
||||
domain : str
|
||||
A string value indicating the domain of this multimethod.
|
||||
default : Optional[Callable], optional
|
||||
The default implementation of this multimethod, where ``None`` (the default) specifies
|
||||
there is no default implementation.
|
||||
|
||||
Examples
|
||||
--------
|
||||
In this example, ``a`` is to be dispatched over, so we return it, while marking it as an ``int``.
|
||||
The trailing comma is needed because the args have to be returned as an iterable.
|
||||
|
||||
>>> def override_me(a, b):
|
||||
... return Dispatchable(a, int),
|
||||
|
||||
Next, we define the argument replacer that replaces the dispatchables inside args/kwargs with the
|
||||
supplied ones.
|
||||
|
||||
>>> def override_replacer(args, kwargs, dispatchables):
|
||||
... return (dispatchables[0], args[1]), {}
|
||||
|
||||
Next, we define the multimethod.
|
||||
|
||||
>>> overridden_me = generate_multimethod(
|
||||
... override_me, override_replacer, "ua_examples"
|
||||
... )
|
||||
|
||||
Notice that there's no default implementation, unless you supply one.
|
||||
|
||||
>>> overridden_me(1, "a")
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
uarray.backend.BackendNotImplementedError: ...
|
||||
>>> overridden_me2 = generate_multimethod(
|
||||
... override_me, override_replacer, "ua_examples", default=lambda x, y: (x, y)
|
||||
... )
|
||||
>>> overridden_me2(1, "a")
|
||||
(1, 'a')
|
||||
|
||||
See Also
|
||||
--------
|
||||
uarray :
|
||||
See the module documentation for how to override the method by creating backends.
|
||||
"""
|
||||
kw_defaults, arg_defaults, opts = get_defaults(argument_extractor)
|
||||
ua_func = _Function(
|
||||
argument_extractor,
|
||||
argument_replacer,
|
||||
domain,
|
||||
arg_defaults,
|
||||
kw_defaults,
|
||||
default,
|
||||
)
|
||||
|
||||
return functools.update_wrapper(ua_func, argument_extractor)
|
||||
|
||||
|
||||
def set_backend(backend, coerce=False, only=False):
|
||||
"""
|
||||
A context manager that sets the preferred backend.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend
|
||||
The backend to set.
|
||||
coerce
|
||||
Whether or not to coerce to a specific backend's types. Implies ``only``.
|
||||
only
|
||||
Whether or not this should be the last backend to try.
|
||||
|
||||
See Also
|
||||
--------
|
||||
skip_backend : A context manager that allows skipping of backends.
|
||||
set_global_backend : Set a single, global backend for a domain.
|
||||
"""
|
||||
try:
|
||||
return backend.__ua_cache__["set", coerce, only]
|
||||
except AttributeError:
|
||||
backend.__ua_cache__ = {}
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
ctx = _SetBackendContext(backend, coerce, only)
|
||||
backend.__ua_cache__["set", coerce, only] = ctx
|
||||
return ctx
|
||||
|
||||
|
||||
def skip_backend(backend):
|
||||
"""
|
||||
A context manager that allows one to skip a given backend from processing
|
||||
entirely. This allows one to use another backend's code in a library that
|
||||
is also a consumer of the same backend.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend
|
||||
The backend to skip.
|
||||
|
||||
See Also
|
||||
--------
|
||||
set_backend : A context manager that allows setting of backends.
|
||||
set_global_backend : Set a single, global backend for a domain.
|
||||
"""
|
||||
try:
|
||||
return backend.__ua_cache__["skip"]
|
||||
except AttributeError:
|
||||
backend.__ua_cache__ = {}
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
ctx = _SkipBackendContext(backend)
|
||||
backend.__ua_cache__["skip"] = ctx
|
||||
return ctx
|
||||
|
||||
|
||||
def get_defaults(f):
|
||||
sig = inspect.signature(f)
|
||||
kw_defaults = {}
|
||||
arg_defaults = []
|
||||
opts = set()
|
||||
for k, v in sig.parameters.items():
|
||||
if v.default is not inspect.Parameter.empty:
|
||||
kw_defaults[k] = v.default
|
||||
if v.kind in (
|
||||
inspect.Parameter.POSITIONAL_ONLY,
|
||||
inspect.Parameter.POSITIONAL_OR_KEYWORD,
|
||||
):
|
||||
arg_defaults.append(v.default)
|
||||
opts.add(k)
|
||||
|
||||
return kw_defaults, tuple(arg_defaults), opts
|
||||
|
||||
|
||||
def set_global_backend(backend, coerce=False, only=False):
|
||||
"""
|
||||
This utility method replaces the default backend for permanent use. It
|
||||
will be tried in the list of backends automatically, unless the
|
||||
``only`` flag is set on a backend. This will be the first tried
|
||||
backend outside the :obj:`set_backend` context manager.
|
||||
|
||||
Note that this method is not thread-safe.
|
||||
|
||||
.. warning::
|
||||
We caution library authors against using this function in
|
||||
their code. We do *not* support this use-case. This function
|
||||
is meant to be used only by users themselves, or by a reference
|
||||
implementation, if one exists.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend
|
||||
The backend to register.
|
||||
|
||||
See Also
|
||||
--------
|
||||
set_backend : A context manager that allows setting of backends.
|
||||
skip_backend : A context manager that allows skipping of backends.
|
||||
"""
|
||||
_uarray.set_global_backend(backend, coerce, only)
|
||||
|
||||
|
||||
def register_backend(backend):
|
||||
"""
|
||||
This utility method sets registers backend for permanent use. It
|
||||
will be tried in the list of backends automatically, unless the
|
||||
``only`` flag is set on a backend.
|
||||
|
||||
Note that this method is not thread-safe.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend
|
||||
The backend to register.
|
||||
"""
|
||||
_uarray.register_backend(backend)
|
||||
|
||||
|
||||
def clear_backends(domain, registered=True, globals=False):
|
||||
"""
|
||||
This utility method clears registered backends.
|
||||
|
||||
.. warning::
|
||||
We caution library authors against using this function in
|
||||
their code. We do *not* support this use-case. This function
|
||||
is meant to be used only by the users themselves.
|
||||
|
||||
.. warning::
|
||||
Do NOT use this method inside a multimethod call, or the
|
||||
program is likely to crash.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
domain : Optional[str]
|
||||
The domain for which to de-register backends. ``None`` means
|
||||
de-register for all domains.
|
||||
registered : bool
|
||||
Whether or not to clear registered backends. See :obj:`register_backend`.
|
||||
globals : bool
|
||||
Whether or not to clear global backends. See :obj:`set_global_backend`.
|
||||
|
||||
See Also
|
||||
--------
|
||||
register_backend : Register a backend globally.
|
||||
set_global_backend : Set a global backend.
|
||||
"""
|
||||
_uarray.clear_backends(domain, registered, globals)
|
||||
|
||||
|
||||
class Dispatchable:
|
||||
"""
|
||||
A utility class which marks an argument with a specific dispatch type.
|
||||
|
||||
|
||||
Attributes
|
||||
----------
|
||||
value
|
||||
The value of the Dispatchable.
|
||||
|
||||
type
|
||||
The type of the Dispatchable.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> x = Dispatchable(1, str)
|
||||
>>> x
|
||||
<Dispatchable: type=<class 'str'>, value=1>
|
||||
|
||||
See Also
|
||||
--------
|
||||
all_of_type
|
||||
Marks all unmarked parameters of a function.
|
||||
|
||||
mark_as
|
||||
Allows one to create a utility function to mark as a given type.
|
||||
"""
|
||||
|
||||
def __init__(self, value, dispatch_type, coercible=True):
|
||||
self.value = value
|
||||
self.type = dispatch_type
|
||||
self.coercible = coercible
|
||||
|
||||
def __getitem__(self, index):
|
||||
return (self.type, self.value)[index]
|
||||
|
||||
def __str__(self):
|
||||
return "<{0}: type={1!r}, value={2!r}>".format(
|
||||
type(self).__name__, self.type, self.value
|
||||
)
|
||||
|
||||
__repr__ = __str__
|
||||
|
||||
|
||||
def mark_as(dispatch_type):
|
||||
"""
|
||||
Creates a utility function to mark something as a specific type.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> mark_int = mark_as(int)
|
||||
>>> mark_int(1)
|
||||
<Dispatchable: type=<class 'int'>, value=1>
|
||||
"""
|
||||
return functools.partial(Dispatchable, dispatch_type=dispatch_type)
|
||||
|
||||
|
||||
def all_of_type(arg_type):
|
||||
"""
|
||||
Marks all unmarked arguments as a given type.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> @all_of_type(str)
|
||||
... def f(a, b):
|
||||
... return a, Dispatchable(b, int)
|
||||
>>> f('a', 1)
|
||||
(<Dispatchable: type=<class 'str'>, value='a'>, <Dispatchable: type=<class 'int'>, value=1>)
|
||||
"""
|
||||
|
||||
def outer(func):
|
||||
@functools.wraps(func)
|
||||
def inner(*args, **kwargs):
|
||||
extracted_args = func(*args, **kwargs)
|
||||
return tuple(
|
||||
Dispatchable(arg, arg_type)
|
||||
if not isinstance(arg, Dispatchable)
|
||||
else arg
|
||||
for arg in extracted_args
|
||||
)
|
||||
|
||||
return inner
|
||||
|
||||
return outer
|
||||
|
||||
|
||||
def wrap_single_convertor(convert_single):
|
||||
"""
|
||||
Wraps a ``__ua_convert__`` defined for a single element to all elements.
|
||||
If any of them return ``NotImplemented``, the operation is assumed to be
|
||||
undefined.
|
||||
|
||||
Accepts a signature of (value, type, coerce).
|
||||
"""
|
||||
|
||||
@functools.wraps(convert_single)
|
||||
def __ua_convert__(dispatchables, coerce):
|
||||
converted = []
|
||||
for d in dispatchables:
|
||||
c = convert_single(d.value, d.type, coerce and d.coercible)
|
||||
|
||||
if c is NotImplemented:
|
||||
return NotImplemented
|
||||
|
||||
converted.append(c)
|
||||
|
||||
return converted
|
||||
|
||||
return __ua_convert__
|
||||
-30
@@ -1,30 +0,0 @@
|
||||
|
||||
def pre_build_hook(build_ext, ext):
|
||||
from scipy._build_utils.compiler_helper import (
|
||||
set_cxx_flags_hook, try_add_flag)
|
||||
cc = build_ext._cxx_compiler
|
||||
args = ext.extra_compile_args
|
||||
|
||||
set_cxx_flags_hook(build_ext, ext)
|
||||
|
||||
if cc.compiler_type == 'msvc':
|
||||
args.append('/EHsc')
|
||||
else:
|
||||
try_add_flag(args, cc, '-fvisibility=hidden')
|
||||
|
||||
|
||||
def configuration(parent_package='', top_path=None):
|
||||
from numpy.distutils.misc_util import Configuration
|
||||
|
||||
config = Configuration('_uarray', parent_package, top_path)
|
||||
config.add_data_files('LICENSE')
|
||||
ext = config.add_extension('_uarray',
|
||||
sources=['_uarray_dispatch.cxx'],
|
||||
language='c++')
|
||||
ext._pre_build_hook = pre_build_hook
|
||||
return config
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
from numpy.distutils.core import setup
|
||||
setup(**configuration(top_path='').todict())
|
||||
Vendored
-550
@@ -1,550 +0,0 @@
|
||||
from contextlib import contextmanager
|
||||
import functools
|
||||
import operator
|
||||
import sys
|
||||
import warnings
|
||||
import numbers
|
||||
from collections import namedtuple
|
||||
import inspect
|
||||
import math
|
||||
from typing import (
|
||||
Optional,
|
||||
Union,
|
||||
TYPE_CHECKING,
|
||||
TypeVar,
|
||||
)
|
||||
|
||||
import numpy as np
|
||||
|
||||
IntNumber = Union[int, np.integer]
|
||||
DecimalNumber = Union[float, np.floating, np.integer]
|
||||
|
||||
# Since Generator was introduced in numpy 1.17, the following condition is needed for
|
||||
# backward compatibility
|
||||
if TYPE_CHECKING:
|
||||
SeedType = Optional[Union[IntNumber, np.random.Generator,
|
||||
np.random.RandomState]]
|
||||
GeneratorType = TypeVar("GeneratorType", bound=Union[np.random.Generator,
|
||||
np.random.RandomState])
|
||||
|
||||
try:
|
||||
from numpy.random import Generator as Generator
|
||||
except ImportError:
|
||||
class Generator(): # type: ignore[no-redef]
|
||||
pass
|
||||
|
||||
|
||||
def _lazywhere(cond, arrays, f, fillvalue=None, f2=None):
|
||||
"""
|
||||
np.where(cond, x, fillvalue) always evaluates x even where cond is False.
|
||||
This one only evaluates f(arr1[cond], arr2[cond], ...).
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> a, b = np.array([1, 2, 3, 4]), np.array([5, 6, 7, 8])
|
||||
>>> def f(a, b):
|
||||
... return a*b
|
||||
>>> _lazywhere(a > 2, (a, b), f, np.nan)
|
||||
array([ nan, nan, 21., 32.])
|
||||
|
||||
Notice, it assumes that all `arrays` are of the same shape, or can be
|
||||
broadcasted together.
|
||||
|
||||
"""
|
||||
cond = np.asarray(cond)
|
||||
if fillvalue is None:
|
||||
if f2 is None:
|
||||
raise ValueError("One of (fillvalue, f2) must be given.")
|
||||
else:
|
||||
fillvalue = np.nan
|
||||
else:
|
||||
if f2 is not None:
|
||||
raise ValueError("Only one of (fillvalue, f2) can be given.")
|
||||
|
||||
args = np.broadcast_arrays(cond, *arrays)
|
||||
cond, arrays = args[0], args[1:]
|
||||
temp = tuple(np.extract(cond, arr) for arr in arrays)
|
||||
tcode = np.mintypecode([a.dtype.char for a in arrays])
|
||||
out = np.full(np.shape(arrays[0]), fill_value=fillvalue, dtype=tcode)
|
||||
np.place(out, cond, f(*temp))
|
||||
if f2 is not None:
|
||||
temp = tuple(np.extract(~cond, arr) for arr in arrays)
|
||||
np.place(out, ~cond, f2(*temp))
|
||||
|
||||
return out
|
||||
|
||||
|
||||
def _lazyselect(condlist, choicelist, arrays, default=0):
|
||||
"""
|
||||
Mimic `np.select(condlist, choicelist)`.
|
||||
|
||||
Notice, it assumes that all `arrays` are of the same shape or can be
|
||||
broadcasted together.
|
||||
|
||||
All functions in `choicelist` must accept array arguments in the order
|
||||
given in `arrays` and must return an array of the same shape as broadcasted
|
||||
`arrays`.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> x = np.arange(6)
|
||||
>>> np.select([x <3, x > 3], [x**2, x**3], default=0)
|
||||
array([ 0, 1, 4, 0, 64, 125])
|
||||
|
||||
>>> _lazyselect([x < 3, x > 3], [lambda x: x**2, lambda x: x**3], (x,))
|
||||
array([ 0., 1., 4., 0., 64., 125.])
|
||||
|
||||
>>> a = -np.ones_like(x)
|
||||
>>> _lazyselect([x < 3, x > 3],
|
||||
... [lambda x, a: x**2, lambda x, a: a * x**3],
|
||||
... (x, a), default=np.nan)
|
||||
array([ 0., 1., 4., nan, -64., -125.])
|
||||
|
||||
"""
|
||||
arrays = np.broadcast_arrays(*arrays)
|
||||
tcode = np.mintypecode([a.dtype.char for a in arrays])
|
||||
out = np.full(np.shape(arrays[0]), fill_value=default, dtype=tcode)
|
||||
for index in range(len(condlist)):
|
||||
func, cond = choicelist[index], condlist[index]
|
||||
if np.all(cond is False):
|
||||
continue
|
||||
cond, _ = np.broadcast_arrays(cond, arrays[0])
|
||||
temp = tuple(np.extract(cond, arr) for arr in arrays)
|
||||
np.place(out, cond, func(*temp))
|
||||
return out
|
||||
|
||||
|
||||
def _aligned_zeros(shape, dtype=float, order="C", align=None):
|
||||
"""Allocate a new ndarray with aligned memory.
|
||||
|
||||
Primary use case for this currently is working around a f2py issue
|
||||
in NumPy 1.9.1, where dtype.alignment is such that np.zeros() does
|
||||
not necessarily create arrays aligned up to it.
|
||||
|
||||
"""
|
||||
dtype = np.dtype(dtype)
|
||||
if align is None:
|
||||
align = dtype.alignment
|
||||
if not hasattr(shape, '__len__'):
|
||||
shape = (shape,)
|
||||
size = functools.reduce(operator.mul, shape) * dtype.itemsize
|
||||
buf = np.empty(size + align + 1, np.uint8)
|
||||
offset = buf.__array_interface__['data'][0] % align
|
||||
if offset != 0:
|
||||
offset = align - offset
|
||||
# Note: slices producing 0-size arrays do not necessarily change
|
||||
# data pointer --- so we use and allocate size+1
|
||||
buf = buf[offset:offset+size+1][:-1]
|
||||
data = np.ndarray(shape, dtype, buf, order=order)
|
||||
data.fill(0)
|
||||
return data
|
||||
|
||||
|
||||
def _prune_array(array):
|
||||
"""Return an array equivalent to the input array. If the input
|
||||
array is a view of a much larger array, copy its contents to a
|
||||
newly allocated array. Otherwise, return the input unchanged.
|
||||
"""
|
||||
if array.base is not None and array.size < array.base.size // 2:
|
||||
return array.copy()
|
||||
return array
|
||||
|
||||
|
||||
def prod(iterable):
|
||||
"""
|
||||
Product of a sequence of numbers.
|
||||
|
||||
Faster than np.prod for short lists like array shapes, and does
|
||||
not overflow if using Python integers.
|
||||
"""
|
||||
product = 1
|
||||
for x in iterable:
|
||||
product *= x
|
||||
return product
|
||||
|
||||
|
||||
def float_factorial(n: int) -> float:
|
||||
"""Compute the factorial and return as a float
|
||||
|
||||
Returns infinity when result is too large for a double
|
||||
"""
|
||||
return float(math.factorial(n)) if n < 171 else np.inf
|
||||
|
||||
|
||||
class DeprecatedImport:
|
||||
"""
|
||||
Deprecated import with redirection and warning.
|
||||
|
||||
Examples
|
||||
--------
|
||||
Suppose you previously had in some module::
|
||||
|
||||
from foo import spam
|
||||
|
||||
If this has to be deprecated, do::
|
||||
|
||||
spam = DeprecatedImport("foo.spam", "baz")
|
||||
|
||||
to redirect users to use "baz" module instead.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, old_module_name, new_module_name):
|
||||
self._old_name = old_module_name
|
||||
self._new_name = new_module_name
|
||||
__import__(self._new_name)
|
||||
self._mod = sys.modules[self._new_name]
|
||||
|
||||
def __dir__(self):
|
||||
return dir(self._mod)
|
||||
|
||||
def __getattr__(self, name):
|
||||
warnings.warn("Module %s is deprecated, use %s instead"
|
||||
% (self._old_name, self._new_name),
|
||||
DeprecationWarning)
|
||||
return getattr(self._mod, name)
|
||||
|
||||
|
||||
# copy-pasted from scikit-learn utils/validation.py
|
||||
# change this to scipy.stats._qmc.check_random_state once numpy 1.16 is dropped
|
||||
def check_random_state(seed):
|
||||
"""Turn `seed` into a `np.random.RandomState` instance.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
seed : {None, int, `numpy.random.Generator`,
|
||||
`numpy.random.RandomState`}, optional
|
||||
|
||||
If `seed` is None (or `np.random`), the `numpy.random.RandomState`
|
||||
singleton is used.
|
||||
If `seed` is an int, a new ``RandomState`` instance is used,
|
||||
seeded with `seed`.
|
||||
If `seed` is already a ``Generator`` or ``RandomState`` instance then
|
||||
that instance is used.
|
||||
|
||||
Returns
|
||||
-------
|
||||
seed : {`numpy.random.Generator`, `numpy.random.RandomState`}
|
||||
Random number generator.
|
||||
|
||||
"""
|
||||
if seed is None or seed is np.random:
|
||||
return np.random.mtrand._rand
|
||||
if isinstance(seed, (numbers.Integral, np.integer)):
|
||||
return np.random.RandomState(seed)
|
||||
if isinstance(seed, np.random.RandomState):
|
||||
return seed
|
||||
try:
|
||||
# Generator is only available in numpy >= 1.17
|
||||
if isinstance(seed, np.random.Generator):
|
||||
return seed
|
||||
except AttributeError:
|
||||
pass
|
||||
raise ValueError('%r cannot be used to seed a numpy.random.RandomState'
|
||||
' instance' % seed)
|
||||
|
||||
|
||||
def _asarray_validated(a, check_finite=True,
|
||||
sparse_ok=False, objects_ok=False, mask_ok=False,
|
||||
as_inexact=False):
|
||||
"""
|
||||
Helper function for SciPy argument validation.
|
||||
|
||||
Many SciPy linear algebra functions do support arbitrary array-like
|
||||
input arguments. Examples of commonly unsupported inputs include
|
||||
matrices containing inf/nan, sparse matrix representations, and
|
||||
matrices with complicated elements.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
a : array_like
|
||||
The array-like input.
|
||||
check_finite : bool, optional
|
||||
Whether to check that the input matrices contain only finite numbers.
|
||||
Disabling may give a performance gain, but may result in problems
|
||||
(crashes, non-termination) if the inputs do contain infinities or NaNs.
|
||||
Default: True
|
||||
sparse_ok : bool, optional
|
||||
True if scipy sparse matrices are allowed.
|
||||
objects_ok : bool, optional
|
||||
True if arrays with dype('O') are allowed.
|
||||
mask_ok : bool, optional
|
||||
True if masked arrays are allowed.
|
||||
as_inexact : bool, optional
|
||||
True to convert the input array to a np.inexact dtype.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ret : ndarray
|
||||
The converted validated array.
|
||||
|
||||
"""
|
||||
if not sparse_ok:
|
||||
import scipy.sparse
|
||||
if scipy.sparse.issparse(a):
|
||||
msg = ('Sparse matrices are not supported by this function. '
|
||||
'Perhaps one of the scipy.sparse.linalg functions '
|
||||
'would work instead.')
|
||||
raise ValueError(msg)
|
||||
if not mask_ok:
|
||||
if np.ma.isMaskedArray(a):
|
||||
raise ValueError('masked arrays are not supported')
|
||||
toarray = np.asarray_chkfinite if check_finite else np.asarray
|
||||
a = toarray(a)
|
||||
if not objects_ok:
|
||||
if a.dtype is np.dtype('O'):
|
||||
raise ValueError('object arrays are not supported')
|
||||
if as_inexact:
|
||||
if not np.issubdtype(a.dtype, np.inexact):
|
||||
a = toarray(a, dtype=np.float_)
|
||||
return a
|
||||
|
||||
|
||||
def _validate_int(k, name, minimum=None):
|
||||
"""
|
||||
Validate a scalar integer.
|
||||
|
||||
This functon can be used to validate an argument to a function
|
||||
that expects the value to be an integer. It uses `operator.index`
|
||||
to validate the value (so, for example, k=2.0 results in a
|
||||
TypeError).
|
||||
|
||||
Parameters
|
||||
----------
|
||||
k : int
|
||||
The value to be validated.
|
||||
name : str
|
||||
The name of the parameter.
|
||||
minimum : int, optional
|
||||
An optional lower bound.
|
||||
"""
|
||||
try:
|
||||
k = operator.index(k)
|
||||
except TypeError:
|
||||
raise TypeError(f'{name} must be an integer.') from None
|
||||
if minimum is not None and k < minimum:
|
||||
raise ValueError(f'{name} must be an integer not less '
|
||||
f'than {minimum}') from None
|
||||
return k
|
||||
|
||||
|
||||
# Add a replacement for inspect.getfullargspec()/
|
||||
# The version below is borrowed from Django,
|
||||
# https://github.com/django/django/pull/4846.
|
||||
|
||||
# Note an inconsistency between inspect.getfullargspec(func) and
|
||||
# inspect.signature(func). If `func` is a bound method, the latter does *not*
|
||||
# list `self` as a first argument, while the former *does*.
|
||||
# Hence, cook up a common ground replacement: `getfullargspec_no_self` which
|
||||
# mimics `inspect.getfullargspec` but does not list `self`.
|
||||
#
|
||||
# This way, the caller code does not need to know whether it uses a legacy
|
||||
# .getfullargspec or a bright and shiny .signature.
|
||||
|
||||
FullArgSpec = namedtuple('FullArgSpec',
|
||||
['args', 'varargs', 'varkw', 'defaults',
|
||||
'kwonlyargs', 'kwonlydefaults', 'annotations'])
|
||||
|
||||
|
||||
def getfullargspec_no_self(func):
|
||||
"""inspect.getfullargspec replacement using inspect.signature.
|
||||
|
||||
If func is a bound method, do not list the 'self' parameter.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
func : callable
|
||||
A callable to inspect
|
||||
|
||||
Returns
|
||||
-------
|
||||
fullargspec : FullArgSpec(args, varargs, varkw, defaults, kwonlyargs,
|
||||
kwonlydefaults, annotations)
|
||||
|
||||
NOTE: if the first argument of `func` is self, it is *not*, I repeat
|
||||
*not*, included in fullargspec.args.
|
||||
This is done for consistency between inspect.getargspec() under
|
||||
Python 2.x, and inspect.signature() under Python 3.x.
|
||||
|
||||
"""
|
||||
sig = inspect.signature(func)
|
||||
args = [
|
||||
p.name for p in sig.parameters.values()
|
||||
if p.kind in [inspect.Parameter.POSITIONAL_OR_KEYWORD,
|
||||
inspect.Parameter.POSITIONAL_ONLY]
|
||||
]
|
||||
varargs = [
|
||||
p.name for p in sig.parameters.values()
|
||||
if p.kind == inspect.Parameter.VAR_POSITIONAL
|
||||
]
|
||||
varargs = varargs[0] if varargs else None
|
||||
varkw = [
|
||||
p.name for p in sig.parameters.values()
|
||||
if p.kind == inspect.Parameter.VAR_KEYWORD
|
||||
]
|
||||
varkw = varkw[0] if varkw else None
|
||||
defaults = tuple(
|
||||
p.default for p in sig.parameters.values()
|
||||
if (p.kind == inspect.Parameter.POSITIONAL_OR_KEYWORD and
|
||||
p.default is not p.empty)
|
||||
) or None
|
||||
kwonlyargs = [
|
||||
p.name for p in sig.parameters.values()
|
||||
if p.kind == inspect.Parameter.KEYWORD_ONLY
|
||||
]
|
||||
kwdefaults = {p.name: p.default for p in sig.parameters.values()
|
||||
if p.kind == inspect.Parameter.KEYWORD_ONLY and
|
||||
p.default is not p.empty}
|
||||
annotations = {p.name: p.annotation for p in sig.parameters.values()
|
||||
if p.annotation is not p.empty}
|
||||
return FullArgSpec(args, varargs, varkw, defaults, kwonlyargs,
|
||||
kwdefaults or None, annotations)
|
||||
|
||||
|
||||
class MapWrapper:
|
||||
"""
|
||||
Parallelisation wrapper for working with map-like callables, such as
|
||||
`multiprocessing.Pool.map`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
pool : int or map-like callable
|
||||
If `pool` is an integer, then it specifies the number of threads to
|
||||
use for parallelization. If ``int(pool) == 1``, then no parallel
|
||||
processing is used and the map builtin is used.
|
||||
If ``pool == -1``, then the pool will utilize all available CPUs.
|
||||
If `pool` is a map-like callable that follows the same
|
||||
calling sequence as the built-in map function, then this callable is
|
||||
used for parallelization.
|
||||
"""
|
||||
def __init__(self, pool=1):
|
||||
self.pool = None
|
||||
self._mapfunc = map
|
||||
self._own_pool = False
|
||||
|
||||
if callable(pool):
|
||||
self.pool = pool
|
||||
self._mapfunc = self.pool
|
||||
else:
|
||||
from multiprocessing import Pool
|
||||
# user supplies a number
|
||||
if int(pool) == -1:
|
||||
# use as many processors as possible
|
||||
self.pool = Pool()
|
||||
self._mapfunc = self.pool.map
|
||||
self._own_pool = True
|
||||
elif int(pool) == 1:
|
||||
pass
|
||||
elif int(pool) > 1:
|
||||
# use the number of processors requested
|
||||
self.pool = Pool(processes=int(pool))
|
||||
self._mapfunc = self.pool.map
|
||||
self._own_pool = True
|
||||
else:
|
||||
raise RuntimeError("Number of workers specified must be -1,"
|
||||
" an int >= 1, or an object with a 'map' "
|
||||
"method")
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def terminate(self):
|
||||
if self._own_pool:
|
||||
self.pool.terminate()
|
||||
|
||||
def join(self):
|
||||
if self._own_pool:
|
||||
self.pool.join()
|
||||
|
||||
def close(self):
|
||||
if self._own_pool:
|
||||
self.pool.close()
|
||||
|
||||
def __exit__(self, exc_type, exc_value, traceback):
|
||||
if self._own_pool:
|
||||
self.pool.close()
|
||||
self.pool.terminate()
|
||||
|
||||
def __call__(self, func, iterable):
|
||||
# only accept one iterable because that's all Pool.map accepts
|
||||
try:
|
||||
return self._mapfunc(func, iterable)
|
||||
except TypeError as e:
|
||||
# wrong number of arguments
|
||||
raise TypeError("The map-like callable must be of the"
|
||||
" form f(func, iterable)") from e
|
||||
|
||||
|
||||
def rng_integers(gen, low, high=None, size=None, dtype='int64',
|
||||
endpoint=False):
|
||||
"""
|
||||
Return random integers from low (inclusive) to high (exclusive), or if
|
||||
endpoint=True, low (inclusive) to high (inclusive). Replaces
|
||||
`RandomState.randint` (with endpoint=False) and
|
||||
`RandomState.random_integers` (with endpoint=True).
|
||||
|
||||
Return random integers from the "discrete uniform" distribution of the
|
||||
specified dtype. If high is None (the default), then results are from
|
||||
0 to low.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
gen : {None, np.random.RandomState, np.random.Generator}
|
||||
Random number generator. If None, then the np.random.RandomState
|
||||
singleton is used.
|
||||
low : int or array-like of ints
|
||||
Lowest (signed) integers to be drawn from the distribution (unless
|
||||
high=None, in which case this parameter is 0 and this value is used
|
||||
for high).
|
||||
high : int or array-like of ints
|
||||
If provided, one above the largest (signed) integer to be drawn from
|
||||
the distribution (see above for behavior if high=None). If array-like,
|
||||
must contain integer values.
|
||||
size : array-like of ints, optional
|
||||
Output shape. If the given shape is, e.g., (m, n, k), then m * n * k
|
||||
samples are drawn. Default is None, in which case a single value is
|
||||
returned.
|
||||
dtype : {str, dtype}, optional
|
||||
Desired dtype of the result. All dtypes are determined by their name,
|
||||
i.e., 'int64', 'int', etc, so byteorder is not available and a specific
|
||||
precision may have different C types depending on the platform.
|
||||
The default value is np.int_.
|
||||
endpoint : bool, optional
|
||||
If True, sample from the interval [low, high] instead of the default
|
||||
[low, high) Defaults to False.
|
||||
|
||||
Returns
|
||||
-------
|
||||
out: int or ndarray of ints
|
||||
size-shaped array of random integers from the appropriate distribution,
|
||||
or a single such random int if size not provided.
|
||||
"""
|
||||
if isinstance(gen, Generator):
|
||||
return gen.integers(low, high=high, size=size, dtype=dtype,
|
||||
endpoint=endpoint)
|
||||
else:
|
||||
if gen is None:
|
||||
# default is RandomState singleton used by np.random.
|
||||
gen = np.random.mtrand._rand
|
||||
if endpoint:
|
||||
# inclusive of endpoint
|
||||
# remember that low and high can be arrays, so don't modify in
|
||||
# place
|
||||
if high is None:
|
||||
return gen.randint(low + 1, size=size, dtype=dtype)
|
||||
if high is not None:
|
||||
return gen.randint(low, high=high + 1, size=size, dtype=dtype)
|
||||
|
||||
# exclusive
|
||||
return gen.randint(low, high=high, size=size, dtype=dtype)
|
||||
|
||||
|
||||
@contextmanager
|
||||
def _fixed_default_rng(seed=1638083107694713882823079058616272161):
|
||||
"""Context with a fixed np.random.default_rng seed."""
|
||||
orig_fun = np.random.default_rng
|
||||
np.random.default_rng = lambda seed=seed: orig_fun(seed)
|
||||
try:
|
||||
yield
|
||||
finally:
|
||||
np.random.default_rng = orig_fun
|
||||
Vendored
-399
@@ -1,399 +0,0 @@
|
||||
# ######################### LICENSE ############################ #
|
||||
|
||||
# Copyright (c) 2005-2015, Michele Simionato
|
||||
# All rights reserved.
|
||||
|
||||
# Redistribution and use in source and binary forms, with or without
|
||||
# modification, are permitted provided that the following conditions are
|
||||
# met:
|
||||
|
||||
# Redistributions of source code must retain the above copyright
|
||||
# notice, this list of conditions and the following disclaimer.
|
||||
# Redistributions in bytecode form must reproduce the above copyright
|
||||
# notice, this list of conditions and the following disclaimer in
|
||||
# the documentation and/or other materials provided with the
|
||||
# distribution.
|
||||
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
# HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
||||
# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
|
||||
# TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
||||
# DAMAGE.
|
||||
|
||||
"""
|
||||
Decorator module, see https://pypi.python.org/pypi/decorator
|
||||
for the documentation.
|
||||
"""
|
||||
import re
|
||||
import sys
|
||||
import inspect
|
||||
import operator
|
||||
import itertools
|
||||
import collections
|
||||
|
||||
from inspect import getfullargspec
|
||||
|
||||
__version__ = '4.0.5'
|
||||
|
||||
|
||||
def get_init(cls):
|
||||
return cls.__init__
|
||||
|
||||
|
||||
# getargspec has been deprecated in Python 3.5
|
||||
ArgSpec = collections.namedtuple(
|
||||
'ArgSpec', 'args varargs varkw defaults')
|
||||
|
||||
|
||||
def getargspec(f):
|
||||
"""A replacement for inspect.getargspec"""
|
||||
spec = getfullargspec(f)
|
||||
return ArgSpec(spec.args, spec.varargs, spec.varkw, spec.defaults)
|
||||
|
||||
|
||||
DEF = re.compile(r'\s*def\s*([_\w][_\w\d]*)\s*\(')
|
||||
|
||||
|
||||
# basic functionality
|
||||
class FunctionMaker:
|
||||
"""
|
||||
An object with the ability to create functions with a given signature.
|
||||
It has attributes name, doc, module, signature, defaults, dict, and
|
||||
methods update and make.
|
||||
"""
|
||||
|
||||
# Atomic get-and-increment provided by the GIL
|
||||
_compile_count = itertools.count()
|
||||
|
||||
def __init__(self, func=None, name=None, signature=None,
|
||||
defaults=None, doc=None, module=None, funcdict=None):
|
||||
self.shortsignature = signature
|
||||
if func:
|
||||
# func can be a class or a callable, but not an instance method
|
||||
self.name = func.__name__
|
||||
if self.name == '<lambda>': # small hack for lambda functions
|
||||
self.name = '_lambda_'
|
||||
self.doc = func.__doc__
|
||||
self.module = func.__module__
|
||||
if inspect.isfunction(func):
|
||||
argspec = getfullargspec(func)
|
||||
self.annotations = getattr(func, '__annotations__', {})
|
||||
for a in ('args', 'varargs', 'varkw', 'defaults', 'kwonlyargs',
|
||||
'kwonlydefaults'):
|
||||
setattr(self, a, getattr(argspec, a))
|
||||
for i, arg in enumerate(self.args):
|
||||
setattr(self, 'arg%d' % i, arg)
|
||||
allargs = list(self.args)
|
||||
allshortargs = list(self.args)
|
||||
if self.varargs:
|
||||
allargs.append('*' + self.varargs)
|
||||
allshortargs.append('*' + self.varargs)
|
||||
elif self.kwonlyargs:
|
||||
allargs.append('*') # single star syntax
|
||||
for a in self.kwonlyargs:
|
||||
allargs.append('%s=None' % a)
|
||||
allshortargs.append('%s=%s' % (a, a))
|
||||
if self.varkw:
|
||||
allargs.append('**' + self.varkw)
|
||||
allshortargs.append('**' + self.varkw)
|
||||
self.signature = ', '.join(allargs)
|
||||
self.shortsignature = ', '.join(allshortargs)
|
||||
self.dict = func.__dict__.copy()
|
||||
# func=None happens when decorating a caller
|
||||
if name:
|
||||
self.name = name
|
||||
if signature is not None:
|
||||
self.signature = signature
|
||||
if defaults:
|
||||
self.defaults = defaults
|
||||
if doc:
|
||||
self.doc = doc
|
||||
if module:
|
||||
self.module = module
|
||||
if funcdict:
|
||||
self.dict = funcdict
|
||||
# check existence required attributes
|
||||
assert hasattr(self, 'name')
|
||||
if not hasattr(self, 'signature'):
|
||||
raise TypeError('You are decorating a non-function: %s' % func)
|
||||
|
||||
def update(self, func, **kw):
|
||||
"Update the signature of func with the data in self"
|
||||
func.__name__ = self.name
|
||||
func.__doc__ = getattr(self, 'doc', None)
|
||||
func.__dict__ = getattr(self, 'dict', {})
|
||||
func.__defaults__ = getattr(self, 'defaults', ())
|
||||
func.__kwdefaults__ = getattr(self, 'kwonlydefaults', None)
|
||||
func.__annotations__ = getattr(self, 'annotations', None)
|
||||
try:
|
||||
frame = sys._getframe(3)
|
||||
except AttributeError: # for IronPython and similar implementations
|
||||
callermodule = '?'
|
||||
else:
|
||||
callermodule = frame.f_globals.get('__name__', '?')
|
||||
func.__module__ = getattr(self, 'module', callermodule)
|
||||
func.__dict__.update(kw)
|
||||
|
||||
def make(self, src_templ, evaldict=None, addsource=False, **attrs):
|
||||
"Make a new function from a given template and update the signature"
|
||||
src = src_templ % vars(self) # expand name and signature
|
||||
evaldict = evaldict or {}
|
||||
mo = DEF.match(src)
|
||||
if mo is None:
|
||||
raise SyntaxError('not a valid function template\n%s' % src)
|
||||
name = mo.group(1) # extract the function name
|
||||
names = set([name] + [arg.strip(' *') for arg in
|
||||
self.shortsignature.split(',')])
|
||||
for n in names:
|
||||
if n in ('_func_', '_call_'):
|
||||
raise NameError('%s is overridden in\n%s' % (n, src))
|
||||
if not src.endswith('\n'): # add a newline just for safety
|
||||
src += '\n' # this is needed in old versions of Python
|
||||
|
||||
# Ensure each generated function has a unique filename for profilers
|
||||
# (such as cProfile) that depend on the tuple of (<filename>,
|
||||
# <definition line>, <function name>) being unique.
|
||||
filename = '<decorator-gen-%d>' % (next(self._compile_count),)
|
||||
try:
|
||||
code = compile(src, filename, 'single')
|
||||
exec(code, evaldict)
|
||||
except: # noqa: E722
|
||||
print('Error in generated code:', file=sys.stderr)
|
||||
print(src, file=sys.stderr)
|
||||
raise
|
||||
func = evaldict[name]
|
||||
if addsource:
|
||||
attrs['__source__'] = src
|
||||
self.update(func, **attrs)
|
||||
return func
|
||||
|
||||
@classmethod
|
||||
def create(cls, obj, body, evaldict, defaults=None,
|
||||
doc=None, module=None, addsource=True, **attrs):
|
||||
"""
|
||||
Create a function from the strings name, signature, and body.
|
||||
evaldict is the evaluation dictionary. If addsource is true, an
|
||||
attribute __source__ is added to the result. The attributes attrs
|
||||
are added, if any.
|
||||
"""
|
||||
if isinstance(obj, str): # "name(signature)"
|
||||
name, rest = obj.strip().split('(', 1)
|
||||
signature = rest[:-1] # strip a right parens
|
||||
func = None
|
||||
else: # a function
|
||||
name = None
|
||||
signature = None
|
||||
func = obj
|
||||
self = cls(func, name, signature, defaults, doc, module)
|
||||
ibody = '\n'.join(' ' + line for line in body.splitlines())
|
||||
return self.make('def %(name)s(%(signature)s):\n' + ibody,
|
||||
evaldict, addsource, **attrs)
|
||||
|
||||
|
||||
def decorate(func, caller):
|
||||
"""
|
||||
decorate(func, caller) decorates a function using a caller.
|
||||
"""
|
||||
evaldict = func.__globals__.copy()
|
||||
evaldict['_call_'] = caller
|
||||
evaldict['_func_'] = func
|
||||
fun = FunctionMaker.create(
|
||||
func, "return _call_(_func_, %(shortsignature)s)",
|
||||
evaldict, __wrapped__=func)
|
||||
if hasattr(func, '__qualname__'):
|
||||
fun.__qualname__ = func.__qualname__
|
||||
return fun
|
||||
|
||||
|
||||
def decorator(caller, _func=None):
|
||||
"""decorator(caller) converts a caller function into a decorator"""
|
||||
if _func is not None: # return a decorated function
|
||||
# this is obsolete behavior; you should use decorate instead
|
||||
return decorate(_func, caller)
|
||||
# else return a decorator function
|
||||
if inspect.isclass(caller):
|
||||
name = caller.__name__.lower()
|
||||
callerfunc = get_init(caller)
|
||||
doc = 'decorator(%s) converts functions/generators into ' \
|
||||
'factories of %s objects' % (caller.__name__, caller.__name__)
|
||||
elif inspect.isfunction(caller):
|
||||
if caller.__name__ == '<lambda>':
|
||||
name = '_lambda_'
|
||||
else:
|
||||
name = caller.__name__
|
||||
callerfunc = caller
|
||||
doc = caller.__doc__
|
||||
else: # assume caller is an object with a __call__ method
|
||||
name = caller.__class__.__name__.lower()
|
||||
callerfunc = caller.__call__.__func__
|
||||
doc = caller.__call__.__doc__
|
||||
evaldict = callerfunc.__globals__.copy()
|
||||
evaldict['_call_'] = caller
|
||||
evaldict['_decorate_'] = decorate
|
||||
return FunctionMaker.create(
|
||||
'%s(func)' % name, 'return _decorate_(func, _call_)',
|
||||
evaldict, doc=doc, module=caller.__module__,
|
||||
__wrapped__=caller)
|
||||
|
||||
|
||||
# ####################### contextmanager ####################### #
|
||||
|
||||
try: # Python >= 3.2
|
||||
from contextlib import _GeneratorContextManager
|
||||
except ImportError: # Python >= 2.5
|
||||
from contextlib import GeneratorContextManager as _GeneratorContextManager
|
||||
|
||||
|
||||
class ContextManager(_GeneratorContextManager):
|
||||
def __call__(self, func):
|
||||
"""Context manager decorator"""
|
||||
return FunctionMaker.create(
|
||||
func, "with _self_: return _func_(%(shortsignature)s)",
|
||||
dict(_self_=self, _func_=func), __wrapped__=func)
|
||||
|
||||
|
||||
init = getfullargspec(_GeneratorContextManager.__init__)
|
||||
n_args = len(init.args)
|
||||
if n_args == 2 and not init.varargs: # (self, genobj) Python 2.7
|
||||
def __init__(self, g, *a, **k):
|
||||
return _GeneratorContextManager.__init__(self, g(*a, **k))
|
||||
ContextManager.__init__ = __init__
|
||||
elif n_args == 2 and init.varargs: # (self, gen, *a, **k) Python 3.4
|
||||
pass
|
||||
elif n_args == 4: # (self, gen, args, kwds) Python 3.5
|
||||
def __init__(self, g, *a, **k):
|
||||
return _GeneratorContextManager.__init__(self, g, a, k)
|
||||
ContextManager.__init__ = __init__
|
||||
|
||||
contextmanager = decorator(ContextManager)
|
||||
|
||||
|
||||
# ############################ dispatch_on ############################ #
|
||||
|
||||
def append(a, vancestors):
|
||||
"""
|
||||
Append ``a`` to the list of the virtual ancestors, unless it is already
|
||||
included.
|
||||
"""
|
||||
add = True
|
||||
for j, va in enumerate(vancestors):
|
||||
if issubclass(va, a):
|
||||
add = False
|
||||
break
|
||||
if issubclass(a, va):
|
||||
vancestors[j] = a
|
||||
add = False
|
||||
if add:
|
||||
vancestors.append(a)
|
||||
|
||||
|
||||
# inspired from simplegeneric by P.J. Eby and functools.singledispatch
|
||||
def dispatch_on(*dispatch_args):
|
||||
"""
|
||||
Factory of decorators turning a function into a generic function
|
||||
dispatching on the given arguments.
|
||||
"""
|
||||
assert dispatch_args, 'No dispatch args passed'
|
||||
dispatch_str = '(%s,)' % ', '.join(dispatch_args)
|
||||
|
||||
def check(arguments, wrong=operator.ne, msg=''):
|
||||
"""Make sure one passes the expected number of arguments"""
|
||||
if wrong(len(arguments), len(dispatch_args)):
|
||||
raise TypeError('Expected %d arguments, got %d%s' %
|
||||
(len(dispatch_args), len(arguments), msg))
|
||||
|
||||
def gen_func_dec(func):
|
||||
"""Decorator turning a function into a generic function"""
|
||||
|
||||
# first check the dispatch arguments
|
||||
argset = set(getfullargspec(func).args)
|
||||
if not set(dispatch_args) <= argset:
|
||||
raise NameError('Unknown dispatch arguments %s' % dispatch_str)
|
||||
|
||||
typemap = {}
|
||||
|
||||
def vancestors(*types):
|
||||
"""
|
||||
Get a list of sets of virtual ancestors for the given types
|
||||
"""
|
||||
check(types)
|
||||
ras = [[] for _ in range(len(dispatch_args))]
|
||||
for types_ in typemap:
|
||||
for t, type_, ra in zip(types, types_, ras):
|
||||
if issubclass(t, type_) and type_ not in t.__mro__:
|
||||
append(type_, ra)
|
||||
return [set(ra) for ra in ras]
|
||||
|
||||
def ancestors(*types):
|
||||
"""
|
||||
Get a list of virtual MROs, one for each type
|
||||
"""
|
||||
check(types)
|
||||
lists = []
|
||||
for t, vas in zip(types, vancestors(*types)):
|
||||
n_vas = len(vas)
|
||||
if n_vas > 1:
|
||||
raise RuntimeError(
|
||||
'Ambiguous dispatch for %s: %s' % (t, vas))
|
||||
elif n_vas == 1:
|
||||
va, = vas
|
||||
mro = type('t', (t, va), {}).__mro__[1:]
|
||||
else:
|
||||
mro = t.__mro__
|
||||
lists.append(mro[:-1]) # discard t and object
|
||||
return lists
|
||||
|
||||
def register(*types):
|
||||
"""
|
||||
Decorator to register an implementation for the given types
|
||||
"""
|
||||
check(types)
|
||||
|
||||
def dec(f):
|
||||
check(getfullargspec(f).args, operator.lt, ' in ' + f.__name__)
|
||||
typemap[types] = f
|
||||
return f
|
||||
return dec
|
||||
|
||||
def dispatch_info(*types):
|
||||
"""
|
||||
An utility to introspect the dispatch algorithm
|
||||
"""
|
||||
check(types)
|
||||
lst = [tuple(a.__name__ for a in anc)
|
||||
for anc in itertools.product(*ancestors(*types))]
|
||||
return lst
|
||||
|
||||
def _dispatch(dispatch_args, *args, **kw):
|
||||
types = tuple(type(arg) for arg in dispatch_args)
|
||||
try: # fast path
|
||||
f = typemap[types]
|
||||
except KeyError:
|
||||
pass
|
||||
else:
|
||||
return f(*args, **kw)
|
||||
combinations = itertools.product(*ancestors(*types))
|
||||
next(combinations) # the first one has been already tried
|
||||
for types_ in combinations:
|
||||
f = typemap.get(types_)
|
||||
if f is not None:
|
||||
return f(*args, **kw)
|
||||
|
||||
# else call the default implementation
|
||||
return func(*args, **kw)
|
||||
|
||||
return FunctionMaker.create(
|
||||
func, 'return _f_(%s, %%(shortsignature)s)' % dispatch_str,
|
||||
dict(_f_=_dispatch), register=register, default=func,
|
||||
typemap=typemap, vancestors=vancestors, ancestors=ancestors,
|
||||
dispatch_info=dispatch_info, __wrapped__=func)
|
||||
|
||||
gen_func_dec.__name__ = 'dispatch_on' + dispatch_str
|
||||
return gen_func_dec
|
||||
-107
@@ -1,107 +0,0 @@
|
||||
import functools
|
||||
import warnings
|
||||
|
||||
__all__ = ["_deprecated"]
|
||||
|
||||
|
||||
def _deprecated(msg, stacklevel=2):
|
||||
"""Deprecate a function by emitting a warning on use."""
|
||||
def wrap(fun):
|
||||
if isinstance(fun, type):
|
||||
warnings.warn(
|
||||
"Trying to deprecate class {!r}".format(fun),
|
||||
category=RuntimeWarning, stacklevel=2)
|
||||
return fun
|
||||
|
||||
@functools.wraps(fun)
|
||||
def call(*args, **kwargs):
|
||||
warnings.warn(msg, category=DeprecationWarning,
|
||||
stacklevel=stacklevel)
|
||||
return fun(*args, **kwargs)
|
||||
call.__doc__ = msg
|
||||
return call
|
||||
|
||||
return wrap
|
||||
|
||||
|
||||
class _DeprecationHelperStr:
|
||||
"""
|
||||
Helper class used by deprecate_cython_api
|
||||
"""
|
||||
def __init__(self, content, message):
|
||||
self._content = content
|
||||
self._message = message
|
||||
|
||||
def __hash__(self):
|
||||
return hash(self._content)
|
||||
|
||||
def __eq__(self, other):
|
||||
res = (self._content == other)
|
||||
if res:
|
||||
warnings.warn(self._message, category=DeprecationWarning,
|
||||
stacklevel=2)
|
||||
return res
|
||||
|
||||
|
||||
def deprecate_cython_api(module, routine_name, new_name=None, message=None):
|
||||
"""
|
||||
Deprecate an exported cdef function in a public Cython API module.
|
||||
|
||||
Only functions can be deprecated; typedefs etc. cannot.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
module : module
|
||||
Public Cython API module (e.g. scipy.linalg.cython_blas).
|
||||
routine_name : str
|
||||
Name of the routine to deprecate. May also be a fused-type
|
||||
routine (in which case its all specializations are deprecated).
|
||||
new_name : str
|
||||
New name to include in the deprecation warning message
|
||||
message : str
|
||||
Additional text in the deprecation warning message
|
||||
|
||||
Examples
|
||||
--------
|
||||
Usually, this function would be used in the top-level of the
|
||||
module ``.pyx`` file:
|
||||
|
||||
>>> from scipy._lib.deprecation import deprecate_cython_api
|
||||
>>> import scipy.linalg.cython_blas as mod
|
||||
>>> deprecate_cython_api(mod, "dgemm", "dgemm_new",
|
||||
... message="Deprecated in Scipy 1.5.0")
|
||||
>>> del deprecate_cython_api, mod
|
||||
|
||||
After this, Cython modules that use the deprecated function emit a
|
||||
deprecation warning when they are imported.
|
||||
|
||||
"""
|
||||
old_name = "{}.{}".format(module.__name__, routine_name)
|
||||
|
||||
if new_name is None:
|
||||
depdoc = "`%s` is deprecated!" % old_name
|
||||
else:
|
||||
depdoc = "`%s` is deprecated, use `%s` instead!" % \
|
||||
(old_name, new_name)
|
||||
|
||||
if message is not None:
|
||||
depdoc += "\n" + message
|
||||
|
||||
d = module.__pyx_capi__
|
||||
|
||||
# Check if the function is a fused-type function with a mangled name
|
||||
j = 0
|
||||
has_fused = False
|
||||
while True:
|
||||
fused_name = "__pyx_fuse_{}{}".format(j, routine_name)
|
||||
if fused_name in d:
|
||||
has_fused = True
|
||||
d[_DeprecationHelperStr(fused_name, depdoc)] = d.pop(fused_name)
|
||||
j += 1
|
||||
else:
|
||||
break
|
||||
|
||||
# If not, apply deprecation to the named routine
|
||||
if not has_fused:
|
||||
d[_DeprecationHelperStr(routine_name, depdoc)] = d.pop(routine_name)
|
||||
|
||||
Vendored
-272
@@ -1,272 +0,0 @@
|
||||
''' Utilities to allow inserting docstring fragments for common
|
||||
parameters into function and method docstrings'''
|
||||
|
||||
import sys
|
||||
|
||||
__all__ = ['docformat', 'inherit_docstring_from', 'indentcount_lines',
|
||||
'filldoc', 'unindent_dict', 'unindent_string', 'doc_replace']
|
||||
|
||||
|
||||
def docformat(docstring, docdict=None):
|
||||
''' Fill a function docstring from variables in dictionary
|
||||
|
||||
Adapt the indent of the inserted docs
|
||||
|
||||
Parameters
|
||||
----------
|
||||
docstring : string
|
||||
docstring from function, possibly with dict formatting strings
|
||||
docdict : dict, optional
|
||||
dictionary with keys that match the dict formatting strings
|
||||
and values that are docstring fragments to be inserted. The
|
||||
indentation of the inserted docstrings is set to match the
|
||||
minimum indentation of the ``docstring`` by adding this
|
||||
indentation to all lines of the inserted string, except the
|
||||
first.
|
||||
|
||||
Returns
|
||||
-------
|
||||
outstring : string
|
||||
string with requested ``docdict`` strings inserted
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> docformat(' Test string with %(value)s', {'value':'inserted value'})
|
||||
' Test string with inserted value'
|
||||
>>> docstring = 'First line\\n Second line\\n %(value)s'
|
||||
>>> inserted_string = "indented\\nstring"
|
||||
>>> docdict = {'value': inserted_string}
|
||||
>>> docformat(docstring, docdict)
|
||||
'First line\\n Second line\\n indented\\n string'
|
||||
'''
|
||||
if not docstring:
|
||||
return docstring
|
||||
if docdict is None:
|
||||
docdict = {}
|
||||
if not docdict:
|
||||
return docstring
|
||||
lines = docstring.expandtabs().splitlines()
|
||||
# Find the minimum indent of the main docstring, after first line
|
||||
if len(lines) < 2:
|
||||
icount = 0
|
||||
else:
|
||||
icount = indentcount_lines(lines[1:])
|
||||
indent = ' ' * icount
|
||||
# Insert this indent to dictionary docstrings
|
||||
indented = {}
|
||||
for name, dstr in docdict.items():
|
||||
lines = dstr.expandtabs().splitlines()
|
||||
try:
|
||||
newlines = [lines[0]]
|
||||
for line in lines[1:]:
|
||||
newlines.append(indent+line)
|
||||
indented[name] = '\n'.join(newlines)
|
||||
except IndexError:
|
||||
indented[name] = dstr
|
||||
return docstring % indented
|
||||
|
||||
|
||||
def inherit_docstring_from(cls):
|
||||
"""
|
||||
This decorator modifies the decorated function's docstring by
|
||||
replacing occurrences of '%(super)s' with the docstring of the
|
||||
method of the same name from the class `cls`.
|
||||
|
||||
If the decorated method has no docstring, it is simply given the
|
||||
docstring of `cls`s method.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
cls : Python class or instance
|
||||
A class with a method with the same name as the decorated method.
|
||||
The docstring of the method in this class replaces '%(super)s' in the
|
||||
docstring of the decorated method.
|
||||
|
||||
Returns
|
||||
-------
|
||||
f : function
|
||||
The decorator function that modifies the __doc__ attribute
|
||||
of its argument.
|
||||
|
||||
Examples
|
||||
--------
|
||||
In the following, the docstring for Bar.func created using the
|
||||
docstring of `Foo.func`.
|
||||
|
||||
>>> class Foo:
|
||||
... def func(self):
|
||||
... '''Do something useful.'''
|
||||
... return
|
||||
...
|
||||
>>> class Bar(Foo):
|
||||
... @inherit_docstring_from(Foo)
|
||||
... def func(self):
|
||||
... '''%(super)s
|
||||
... Do it fast.
|
||||
... '''
|
||||
... return
|
||||
...
|
||||
>>> b = Bar()
|
||||
>>> b.func.__doc__
|
||||
'Do something useful.\n Do it fast.\n '
|
||||
|
||||
"""
|
||||
def _doc(func):
|
||||
cls_docstring = getattr(cls, func.__name__).__doc__
|
||||
func_docstring = func.__doc__
|
||||
if func_docstring is None:
|
||||
func.__doc__ = cls_docstring
|
||||
else:
|
||||
new_docstring = func_docstring % dict(super=cls_docstring)
|
||||
func.__doc__ = new_docstring
|
||||
return func
|
||||
return _doc
|
||||
|
||||
|
||||
def extend_notes_in_docstring(cls, notes):
|
||||
"""
|
||||
This decorator replaces the decorated function's docstring
|
||||
with the docstring from corresponding method in `cls`.
|
||||
It extends the 'Notes' section of that docstring to include
|
||||
the given `notes`.
|
||||
"""
|
||||
def _doc(func):
|
||||
cls_docstring = getattr(cls, func.__name__).__doc__
|
||||
# If python is called with -OO option,
|
||||
# there is no docstring
|
||||
if cls_docstring is None:
|
||||
return func
|
||||
end_of_notes = cls_docstring.find(' References\n')
|
||||
if end_of_notes == -1:
|
||||
end_of_notes = cls_docstring.find(' Examples\n')
|
||||
if end_of_notes == -1:
|
||||
end_of_notes = len(cls_docstring)
|
||||
func.__doc__ = (cls_docstring[:end_of_notes] + notes +
|
||||
cls_docstring[end_of_notes:])
|
||||
return func
|
||||
return _doc
|
||||
|
||||
|
||||
def replace_notes_in_docstring(cls, notes):
|
||||
"""
|
||||
This decorator replaces the decorated function's docstring
|
||||
with the docstring from corresponding method in `cls`.
|
||||
It replaces the 'Notes' section of that docstring with
|
||||
the given `notes`.
|
||||
"""
|
||||
def _doc(func):
|
||||
cls_docstring = getattr(cls, func.__name__).__doc__
|
||||
notes_header = ' Notes\n -----\n'
|
||||
# If python is called with -OO option,
|
||||
# there is no docstring
|
||||
if cls_docstring is None:
|
||||
return func
|
||||
start_of_notes = cls_docstring.find(notes_header)
|
||||
end_of_notes = cls_docstring.find(' References\n')
|
||||
if end_of_notes == -1:
|
||||
end_of_notes = cls_docstring.find(' Examples\n')
|
||||
if end_of_notes == -1:
|
||||
end_of_notes = len(cls_docstring)
|
||||
func.__doc__ = (cls_docstring[:start_of_notes + len(notes_header)] +
|
||||
notes +
|
||||
cls_docstring[end_of_notes:])
|
||||
return func
|
||||
return _doc
|
||||
|
||||
|
||||
def indentcount_lines(lines):
|
||||
''' Minimum indent for all lines in line list
|
||||
|
||||
>>> lines = [' one', ' two', ' three']
|
||||
>>> indentcount_lines(lines)
|
||||
1
|
||||
>>> lines = []
|
||||
>>> indentcount_lines(lines)
|
||||
0
|
||||
>>> lines = [' one']
|
||||
>>> indentcount_lines(lines)
|
||||
1
|
||||
>>> indentcount_lines([' '])
|
||||
0
|
||||
'''
|
||||
indentno = sys.maxsize
|
||||
for line in lines:
|
||||
stripped = line.lstrip()
|
||||
if stripped:
|
||||
indentno = min(indentno, len(line) - len(stripped))
|
||||
if indentno == sys.maxsize:
|
||||
return 0
|
||||
return indentno
|
||||
|
||||
|
||||
def filldoc(docdict, unindent_params=True):
|
||||
''' Return docstring decorator using docdict variable dictionary
|
||||
|
||||
Parameters
|
||||
----------
|
||||
docdict : dictionary
|
||||
dictionary containing name, docstring fragment pairs
|
||||
unindent_params : {False, True}, boolean, optional
|
||||
If True, strip common indentation from all parameters in
|
||||
docdict
|
||||
|
||||
Returns
|
||||
-------
|
||||
decfunc : function
|
||||
decorator that applies dictionary to input function docstring
|
||||
|
||||
'''
|
||||
if unindent_params:
|
||||
docdict = unindent_dict(docdict)
|
||||
|
||||
def decorate(f):
|
||||
f.__doc__ = docformat(f.__doc__, docdict)
|
||||
return f
|
||||
return decorate
|
||||
|
||||
|
||||
def unindent_dict(docdict):
|
||||
''' Unindent all strings in a docdict '''
|
||||
can_dict = {}
|
||||
for name, dstr in docdict.items():
|
||||
can_dict[name] = unindent_string(dstr)
|
||||
return can_dict
|
||||
|
||||
|
||||
def unindent_string(docstring):
|
||||
''' Set docstring to minimum indent for all lines, including first
|
||||
|
||||
>>> unindent_string(' two')
|
||||
'two'
|
||||
>>> unindent_string(' two\\n three')
|
||||
'two\\n three'
|
||||
'''
|
||||
lines = docstring.expandtabs().splitlines()
|
||||
icount = indentcount_lines(lines)
|
||||
if icount == 0:
|
||||
return docstring
|
||||
return '\n'.join([line[icount:] for line in lines])
|
||||
|
||||
|
||||
def doc_replace(obj, oldval, newval):
|
||||
"""Decorator to take the docstring from obj, with oldval replaced by newval
|
||||
|
||||
Equivalent to ``func.__doc__ = obj.__doc__.replace(oldval, newval)``
|
||||
|
||||
Parameters
|
||||
----------
|
||||
obj : object
|
||||
The object to take the docstring from.
|
||||
oldval : string
|
||||
The string to replace from the original docstring.
|
||||
newval : string
|
||||
The string to replace ``oldval`` with.
|
||||
"""
|
||||
# __doc__ may be None for optimized Python (-OO)
|
||||
doc = (obj.__doc__ or '').replace(oldval, newval)
|
||||
|
||||
def inner(func):
|
||||
func.__doc__ = doc
|
||||
return func
|
||||
|
||||
return inner
|
||||
Vendored
-88
@@ -1,88 +0,0 @@
|
||||
import os
|
||||
import pathlib
|
||||
|
||||
|
||||
def check_boost_submodule():
|
||||
from scipy._lib._boost_utils import _boost_dir
|
||||
|
||||
if not os.path.exists(_boost_dir(ret_path=True) / 'README.md'):
|
||||
raise RuntimeError("Missing the `boost` submodule! Run `git submodule "
|
||||
"update --init` to fix this.")
|
||||
|
||||
|
||||
def build_clib_pre_build_hook(cmd, ext):
|
||||
from scipy._build_utils.compiler_helper import get_cxx_std_flag
|
||||
std_flag = get_cxx_std_flag(cmd.compiler)
|
||||
ext.setdefault('extra_compiler_args', [])
|
||||
if std_flag is not None:
|
||||
ext['extra_compiler_args'].append(std_flag)
|
||||
|
||||
|
||||
def configuration(parent_package='',top_path=None):
|
||||
from numpy.distutils.misc_util import Configuration
|
||||
from scipy._lib._boost_utils import _boost_dir
|
||||
|
||||
check_boost_submodule()
|
||||
|
||||
config = Configuration('_lib', parent_package, top_path)
|
||||
config.add_data_files('tests/*.py')
|
||||
|
||||
include_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), 'src'))
|
||||
depends = [os.path.join(include_dir, 'ccallback.h')]
|
||||
|
||||
config.add_extension("_ccallback_c",
|
||||
sources=["_ccallback_c.c"],
|
||||
depends=depends,
|
||||
include_dirs=[include_dir])
|
||||
|
||||
config.add_extension("_test_ccallback",
|
||||
sources=["src/_test_ccallback.c"],
|
||||
depends=depends,
|
||||
include_dirs=[include_dir])
|
||||
|
||||
config.add_extension("_fpumode",
|
||||
sources=["_fpumode.c"])
|
||||
|
||||
def get_messagestream_config(ext, build_dir):
|
||||
# Generate a header file containing defines
|
||||
config_cmd = config.get_config_cmd()
|
||||
defines = []
|
||||
if config_cmd.check_func('open_memstream', decl=True, call=True):
|
||||
defines.append(('HAVE_OPEN_MEMSTREAM', '1'))
|
||||
target = os.path.join(os.path.dirname(__file__), 'src',
|
||||
'messagestream_config.h')
|
||||
with open(target, 'w') as f:
|
||||
for name, value in defines:
|
||||
f.write('#define {0} {1}\n'.format(name, value))
|
||||
|
||||
depends = [os.path.join(include_dir, 'messagestream.h')]
|
||||
config.add_extension("messagestream",
|
||||
sources=["messagestream.c"] + [get_messagestream_config],
|
||||
depends=depends,
|
||||
include_dirs=[include_dir])
|
||||
|
||||
config.add_extension("_test_deprecation_call",
|
||||
sources=["_test_deprecation_call.c"],
|
||||
include_dirs=[include_dir])
|
||||
|
||||
config.add_extension("_test_deprecation_def",
|
||||
sources=["_test_deprecation_def.c"],
|
||||
include_dirs=[include_dir])
|
||||
|
||||
config.add_subpackage('_uarray')
|
||||
|
||||
# ensure Boost was checked out and builds
|
||||
config.add_library(
|
||||
'test_boost_build',
|
||||
sources=['tests/test_boost_build.cpp'],
|
||||
include_dirs=_boost_dir(),
|
||||
language='c++',
|
||||
_pre_build_hook=build_clib_pre_build_hook)
|
||||
|
||||
return config
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
from numpy.distutils.core import setup
|
||||
|
||||
setup(**configuration(top_path='').todict())
|
||||
-101
@@ -1,101 +0,0 @@
|
||||
""" Test for assert_deallocated context manager and gc utilities
|
||||
"""
|
||||
import gc
|
||||
|
||||
from scipy._lib._gcutils import (set_gc_state, gc_state, assert_deallocated,
|
||||
ReferenceError, IS_PYPY)
|
||||
|
||||
from numpy.testing import assert_equal
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
def test_set_gc_state():
|
||||
gc_status = gc.isenabled()
|
||||
try:
|
||||
for state in (True, False):
|
||||
gc.enable()
|
||||
set_gc_state(state)
|
||||
assert_equal(gc.isenabled(), state)
|
||||
gc.disable()
|
||||
set_gc_state(state)
|
||||
assert_equal(gc.isenabled(), state)
|
||||
finally:
|
||||
if gc_status:
|
||||
gc.enable()
|
||||
|
||||
|
||||
def test_gc_state():
|
||||
# Test gc_state context manager
|
||||
gc_status = gc.isenabled()
|
||||
try:
|
||||
for pre_state in (True, False):
|
||||
set_gc_state(pre_state)
|
||||
for with_state in (True, False):
|
||||
# Check the gc state is with_state in with block
|
||||
with gc_state(with_state):
|
||||
assert_equal(gc.isenabled(), with_state)
|
||||
# And returns to previous state outside block
|
||||
assert_equal(gc.isenabled(), pre_state)
|
||||
# Even if the gc state is set explicitly within the block
|
||||
with gc_state(with_state):
|
||||
assert_equal(gc.isenabled(), with_state)
|
||||
set_gc_state(not with_state)
|
||||
assert_equal(gc.isenabled(), pre_state)
|
||||
finally:
|
||||
if gc_status:
|
||||
gc.enable()
|
||||
|
||||
|
||||
@pytest.mark.skipif(IS_PYPY, reason="Test not meaningful on PyPy")
|
||||
def test_assert_deallocated():
|
||||
# Ordinary use
|
||||
class C:
|
||||
def __init__(self, arg0, arg1, name='myname'):
|
||||
self.name = name
|
||||
for gc_current in (True, False):
|
||||
with gc_state(gc_current):
|
||||
# We are deleting from with-block context, so that's OK
|
||||
with assert_deallocated(C, 0, 2, 'another name') as c:
|
||||
assert_equal(c.name, 'another name')
|
||||
del c
|
||||
# Or not using the thing in with-block context, also OK
|
||||
with assert_deallocated(C, 0, 2, name='third name'):
|
||||
pass
|
||||
assert_equal(gc.isenabled(), gc_current)
|
||||
|
||||
|
||||
@pytest.mark.skipif(IS_PYPY, reason="Test not meaningful on PyPy")
|
||||
def test_assert_deallocated_nodel():
|
||||
class C:
|
||||
pass
|
||||
with pytest.raises(ReferenceError):
|
||||
# Need to delete after using if in with-block context
|
||||
# Note: assert_deallocated(C) needs to be assigned for the test
|
||||
# to function correctly. It is assigned to c, but c itself is
|
||||
# not referenced in the body of the with, it is only there for
|
||||
# the refcount.
|
||||
with assert_deallocated(C) as c:
|
||||
pass
|
||||
|
||||
|
||||
@pytest.mark.skipif(IS_PYPY, reason="Test not meaningful on PyPy")
|
||||
def test_assert_deallocated_circular():
|
||||
class C:
|
||||
def __init__(self):
|
||||
self._circular = self
|
||||
with pytest.raises(ReferenceError):
|
||||
# Circular reference, no automatic garbage collection
|
||||
with assert_deallocated(C) as c:
|
||||
del c
|
||||
|
||||
|
||||
@pytest.mark.skipif(IS_PYPY, reason="Test not meaningful on PyPy")
|
||||
def test_assert_deallocated_circular2():
|
||||
class C:
|
||||
def __init__(self):
|
||||
self._circular = self
|
||||
with pytest.raises(ReferenceError):
|
||||
# Still circular reference, no automatic garbage collection
|
||||
with assert_deallocated(C):
|
||||
pass
|
||||
-67
@@ -1,67 +0,0 @@
|
||||
from pytest import raises as assert_raises
|
||||
from scipy._lib._pep440 import Version, parse
|
||||
|
||||
|
||||
def test_main_versions():
|
||||
assert Version('1.8.0') == Version('1.8.0')
|
||||
for ver in ['1.9.0', '2.0.0', '1.8.1']:
|
||||
assert Version('1.8.0') < Version(ver)
|
||||
|
||||
for ver in ['1.7.0', '1.7.1', '0.9.9']:
|
||||
assert Version('1.8.0') > Version(ver)
|
||||
|
||||
|
||||
def test_version_1_point_10():
|
||||
# regression test for gh-2998.
|
||||
assert Version('1.9.0') < Version('1.10.0')
|
||||
assert Version('1.11.0') < Version('1.11.1')
|
||||
assert Version('1.11.0') == Version('1.11.0')
|
||||
assert Version('1.99.11') < Version('1.99.12')
|
||||
|
||||
|
||||
def test_alpha_beta_rc():
|
||||
assert Version('1.8.0rc1') == Version('1.8.0rc1')
|
||||
for ver in ['1.8.0', '1.8.0rc2']:
|
||||
assert Version('1.8.0rc1') < Version(ver)
|
||||
|
||||
for ver in ['1.8.0a2', '1.8.0b3', '1.7.2rc4']:
|
||||
assert Version('1.8.0rc1') > Version(ver)
|
||||
|
||||
assert Version('1.8.0b1') > Version('1.8.0a2')
|
||||
|
||||
|
||||
def test_dev_version():
|
||||
assert Version('1.9.0.dev+Unknown') < Version('1.9.0')
|
||||
for ver in ['1.9.0', '1.9.0a1', '1.9.0b2', '1.9.0b2.dev+ffffffff', '1.9.0.dev1']:
|
||||
assert Version('1.9.0.dev+f16acvda') < Version(ver)
|
||||
|
||||
assert Version('1.9.0.dev+f16acvda') == Version('1.9.0.dev+f16acvda')
|
||||
|
||||
|
||||
def test_dev_a_b_rc_mixed():
|
||||
assert Version('1.9.0a2.dev+f16acvda') == Version('1.9.0a2.dev+f16acvda')
|
||||
assert Version('1.9.0a2.dev+6acvda54') < Version('1.9.0a2')
|
||||
|
||||
|
||||
def test_dev0_version():
|
||||
assert Version('1.9.0.dev0+Unknown') < Version('1.9.0')
|
||||
for ver in ['1.9.0', '1.9.0a1', '1.9.0b2', '1.9.0b2.dev0+ffffffff']:
|
||||
assert Version('1.9.0.dev0+f16acvda') < Version(ver)
|
||||
|
||||
assert Version('1.9.0.dev0+f16acvda') == Version('1.9.0.dev0+f16acvda')
|
||||
|
||||
|
||||
def test_dev0_a_b_rc_mixed():
|
||||
assert Version('1.9.0a2.dev0+f16acvda') == Version('1.9.0a2.dev0+f16acvda')
|
||||
assert Version('1.9.0a2.dev0+6acvda54') < Version('1.9.0a2')
|
||||
|
||||
|
||||
def test_raises():
|
||||
for ver in ['1,9.0', '1.7.x']:
|
||||
assert_raises(ValueError, Version, ver)
|
||||
|
||||
def test_legacy_version():
|
||||
# Non-PEP-440 version identifiers always compare less. For NumPy this only
|
||||
# occurs on dev builds prior to 1.10.0 which are unsupported anyway.
|
||||
assert parse('invalid') < Version('0.0.0')
|
||||
assert parse('1.9.0-f16acvda') < Version('1.0.0')
|
||||
-32
@@ -1,32 +0,0 @@
|
||||
import sys
|
||||
from scipy._lib._testutils import _parse_size, _get_mem_available
|
||||
import pytest
|
||||
|
||||
|
||||
def test__parse_size():
|
||||
expected = {
|
||||
'12': 12e6,
|
||||
'12 b': 12,
|
||||
'12k': 12e3,
|
||||
' 12 M ': 12e6,
|
||||
' 12 G ': 12e9,
|
||||
' 12Tb ': 12e12,
|
||||
'12 Mib ': 12 * 1024.0**2,
|
||||
'12Tib': 12 * 1024.0**4,
|
||||
}
|
||||
|
||||
for inp, outp in sorted(expected.items()):
|
||||
if outp is None:
|
||||
with pytest.raises(ValueError):
|
||||
_parse_size(inp)
|
||||
else:
|
||||
assert _parse_size(inp) == outp
|
||||
|
||||
|
||||
def test__mem_available():
|
||||
# May return None on non-Linux platforms
|
||||
available = _get_mem_available()
|
||||
if sys.platform.startswith('linux'):
|
||||
assert available >= 0
|
||||
else:
|
||||
assert available is None or available >= 0
|
||||
@@ -1,51 +0,0 @@
|
||||
import threading
|
||||
import time
|
||||
import traceback
|
||||
|
||||
from numpy.testing import assert_
|
||||
from pytest import raises as assert_raises
|
||||
|
||||
from scipy._lib._threadsafety import ReentrancyLock, non_reentrant, ReentrancyError
|
||||
|
||||
|
||||
def test_parallel_threads():
|
||||
# Check that ReentrancyLock serializes work in parallel threads.
|
||||
#
|
||||
# The test is not fully deterministic, and may succeed falsely if
|
||||
# the timings go wrong.
|
||||
|
||||
lock = ReentrancyLock("failure")
|
||||
|
||||
failflag = [False]
|
||||
exceptions_raised = []
|
||||
|
||||
def worker(k):
|
||||
try:
|
||||
with lock:
|
||||
assert_(not failflag[0])
|
||||
failflag[0] = True
|
||||
time.sleep(0.1 * k)
|
||||
assert_(failflag[0])
|
||||
failflag[0] = False
|
||||
except Exception:
|
||||
exceptions_raised.append(traceback.format_exc(2))
|
||||
|
||||
threads = [threading.Thread(target=lambda k=k: worker(k))
|
||||
for k in range(3)]
|
||||
for t in threads:
|
||||
t.start()
|
||||
for t in threads:
|
||||
t.join()
|
||||
|
||||
exceptions_raised = "\n".join(exceptions_raised)
|
||||
assert_(not exceptions_raised, exceptions_raised)
|
||||
|
||||
|
||||
def test_reentering():
|
||||
# Check that ReentrancyLock prevents re-entering from the same thread.
|
||||
|
||||
@non_reentrant()
|
||||
def func(x):
|
||||
return func(x)
|
||||
|
||||
assert_raises(ReentrancyError, func, 0)
|
||||
-264
@@ -1,264 +0,0 @@
|
||||
from multiprocessing import Pool
|
||||
from multiprocessing.pool import Pool as PWL
|
||||
import os
|
||||
import math
|
||||
from fractions import Fraction
|
||||
|
||||
import numpy as np
|
||||
from numpy.testing import assert_equal, assert_
|
||||
import pytest
|
||||
from pytest import raises as assert_raises, deprecated_call
|
||||
|
||||
import scipy
|
||||
from scipy._lib._util import (_aligned_zeros, check_random_state, MapWrapper,
|
||||
getfullargspec_no_self, FullArgSpec,
|
||||
rng_integers, _validate_int)
|
||||
|
||||
|
||||
def test__aligned_zeros():
|
||||
niter = 10
|
||||
|
||||
def check(shape, dtype, order, align):
|
||||
err_msg = repr((shape, dtype, order, align))
|
||||
x = _aligned_zeros(shape, dtype, order, align=align)
|
||||
if align is None:
|
||||
align = np.dtype(dtype).alignment
|
||||
assert_equal(x.__array_interface__['data'][0] % align, 0)
|
||||
if hasattr(shape, '__len__'):
|
||||
assert_equal(x.shape, shape, err_msg)
|
||||
else:
|
||||
assert_equal(x.shape, (shape,), err_msg)
|
||||
assert_equal(x.dtype, dtype)
|
||||
if order == "C":
|
||||
assert_(x.flags.c_contiguous, err_msg)
|
||||
elif order == "F":
|
||||
if x.size > 0:
|
||||
# Size-0 arrays get invalid flags on NumPy 1.5
|
||||
assert_(x.flags.f_contiguous, err_msg)
|
||||
elif order is None:
|
||||
assert_(x.flags.c_contiguous, err_msg)
|
||||
else:
|
||||
raise ValueError()
|
||||
|
||||
# try various alignments
|
||||
for align in [1, 2, 3, 4, 8, 16, 32, 64, None]:
|
||||
for n in [0, 1, 3, 11]:
|
||||
for order in ["C", "F", None]:
|
||||
for dtype in [np.uint8, np.float64]:
|
||||
for shape in [n, (1, 2, 3, n)]:
|
||||
for j in range(niter):
|
||||
check(shape, dtype, order, align)
|
||||
|
||||
|
||||
def test_check_random_state():
|
||||
# If seed is None, return the RandomState singleton used by np.random.
|
||||
# If seed is an int, return a new RandomState instance seeded with seed.
|
||||
# If seed is already a RandomState instance, return it.
|
||||
# Otherwise raise ValueError.
|
||||
rsi = check_random_state(1)
|
||||
assert_equal(type(rsi), np.random.RandomState)
|
||||
rsi = check_random_state(rsi)
|
||||
assert_equal(type(rsi), np.random.RandomState)
|
||||
rsi = check_random_state(None)
|
||||
assert_equal(type(rsi), np.random.RandomState)
|
||||
assert_raises(ValueError, check_random_state, 'a')
|
||||
if hasattr(np.random, 'Generator'):
|
||||
# np.random.Generator is only available in NumPy >= 1.17
|
||||
rg = np.random.Generator(np.random.PCG64())
|
||||
rsi = check_random_state(rg)
|
||||
assert_equal(type(rsi), np.random.Generator)
|
||||
|
||||
|
||||
def test_getfullargspec_no_self():
|
||||
p = MapWrapper(1)
|
||||
argspec = getfullargspec_no_self(p.__init__)
|
||||
assert_equal(argspec, FullArgSpec(['pool'], None, None, (1,), [],
|
||||
None, {}))
|
||||
argspec = getfullargspec_no_self(p.__call__)
|
||||
assert_equal(argspec, FullArgSpec(['func', 'iterable'], None, None, None,
|
||||
[], None, {}))
|
||||
|
||||
class _rv_generic:
|
||||
def _rvs(self, a, b=2, c=3, *args, size=None, **kwargs):
|
||||
return None
|
||||
|
||||
rv_obj = _rv_generic()
|
||||
argspec = getfullargspec_no_self(rv_obj._rvs)
|
||||
assert_equal(argspec, FullArgSpec(['a', 'b', 'c'], 'args', 'kwargs',
|
||||
(2, 3), ['size'], {'size': None}, {}))
|
||||
|
||||
|
||||
def test_mapwrapper_serial():
|
||||
in_arg = np.arange(10.)
|
||||
out_arg = np.sin(in_arg)
|
||||
|
||||
p = MapWrapper(1)
|
||||
assert_(p._mapfunc is map)
|
||||
assert_(p.pool is None)
|
||||
assert_(p._own_pool is False)
|
||||
out = list(p(np.sin, in_arg))
|
||||
assert_equal(out, out_arg)
|
||||
|
||||
with assert_raises(RuntimeError):
|
||||
p = MapWrapper(0)
|
||||
|
||||
|
||||
def test_pool():
|
||||
with Pool(2) as p:
|
||||
p.map(math.sin, [1, 2, 3, 4])
|
||||
|
||||
|
||||
def test_mapwrapper_parallel():
|
||||
in_arg = np.arange(10.)
|
||||
out_arg = np.sin(in_arg)
|
||||
|
||||
with MapWrapper(2) as p:
|
||||
out = p(np.sin, in_arg)
|
||||
assert_equal(list(out), out_arg)
|
||||
|
||||
assert_(p._own_pool is True)
|
||||
assert_(isinstance(p.pool, PWL))
|
||||
assert_(p._mapfunc is not None)
|
||||
|
||||
# the context manager should've closed the internal pool
|
||||
# check that it has by asking it to calculate again.
|
||||
with assert_raises(Exception) as excinfo:
|
||||
p(np.sin, in_arg)
|
||||
|
||||
assert_(excinfo.type is ValueError)
|
||||
|
||||
# can also set a PoolWrapper up with a map-like callable instance
|
||||
with Pool(2) as p:
|
||||
q = MapWrapper(p.map)
|
||||
|
||||
assert_(q._own_pool is False)
|
||||
q.close()
|
||||
|
||||
# closing the PoolWrapper shouldn't close the internal pool
|
||||
# because it didn't create it
|
||||
out = p.map(np.sin, in_arg)
|
||||
assert_equal(list(out), out_arg)
|
||||
|
||||
|
||||
# get our custom ones and a few from the "import *" cases
|
||||
@pytest.mark.parametrize(
|
||||
'key', ('ifft', 'diag', 'arccos', 'randn', 'rand', 'array'))
|
||||
def test_numpy_deprecation(key):
|
||||
"""Test that 'from numpy import *' functions are deprecated."""
|
||||
if key in ('ifft', 'diag', 'arccos'):
|
||||
arg = [1.0, 0.]
|
||||
elif key == 'finfo':
|
||||
arg = float
|
||||
else:
|
||||
arg = 2
|
||||
func = getattr(scipy, key)
|
||||
match = r'scipy\.%s is deprecated.*2\.0\.0' % key
|
||||
with deprecated_call(match=match) as dep:
|
||||
func(arg) # deprecated
|
||||
# in case we catch more than one dep warning
|
||||
fnames = [os.path.splitext(d.filename)[0] for d in dep.list]
|
||||
basenames = [os.path.basename(fname) for fname in fnames]
|
||||
assert 'test__util' in basenames
|
||||
if key in ('rand', 'randn'):
|
||||
root = np.random
|
||||
elif key == 'ifft':
|
||||
root = np.fft
|
||||
else:
|
||||
root = np
|
||||
func_np = getattr(root, key)
|
||||
func_np(arg) # not deprecated
|
||||
assert func_np is not func
|
||||
# classes should remain classes
|
||||
if isinstance(func_np, type):
|
||||
assert isinstance(func, type)
|
||||
|
||||
|
||||
def test_numpy_deprecation_functionality():
|
||||
# Check that the deprecation wrappers don't break basic NumPy
|
||||
# functionality
|
||||
with deprecated_call():
|
||||
x = scipy.array([1, 2, 3], dtype=scipy.float64)
|
||||
assert x.dtype == scipy.float64
|
||||
assert x.dtype == np.float64
|
||||
|
||||
x = scipy.finfo(scipy.float32)
|
||||
assert x.eps == np.finfo(np.float32).eps
|
||||
|
||||
assert scipy.float64 == np.float64
|
||||
assert issubclass(np.float64, scipy.float64)
|
||||
|
||||
|
||||
def test_rng_integers():
|
||||
rng = np.random.RandomState()
|
||||
|
||||
# test that numbers are inclusive of high point
|
||||
arr = rng_integers(rng, low=2, high=5, size=100, endpoint=True)
|
||||
assert np.max(arr) == 5
|
||||
assert np.min(arr) == 2
|
||||
assert arr.shape == (100, )
|
||||
|
||||
# test that numbers are inclusive of high point
|
||||
arr = rng_integers(rng, low=5, size=100, endpoint=True)
|
||||
assert np.max(arr) == 5
|
||||
assert np.min(arr) == 0
|
||||
assert arr.shape == (100, )
|
||||
|
||||
# test that numbers are exclusive of high point
|
||||
arr = rng_integers(rng, low=2, high=5, size=100, endpoint=False)
|
||||
assert np.max(arr) == 4
|
||||
assert np.min(arr) == 2
|
||||
assert arr.shape == (100, )
|
||||
|
||||
# test that numbers are exclusive of high point
|
||||
arr = rng_integers(rng, low=5, size=100, endpoint=False)
|
||||
assert np.max(arr) == 4
|
||||
assert np.min(arr) == 0
|
||||
assert arr.shape == (100, )
|
||||
|
||||
# now try with np.random.Generator
|
||||
try:
|
||||
rng = np.random.default_rng()
|
||||
except AttributeError:
|
||||
return
|
||||
|
||||
# test that numbers are inclusive of high point
|
||||
arr = rng_integers(rng, low=2, high=5, size=100, endpoint=True)
|
||||
assert np.max(arr) == 5
|
||||
assert np.min(arr) == 2
|
||||
assert arr.shape == (100, )
|
||||
|
||||
# test that numbers are inclusive of high point
|
||||
arr = rng_integers(rng, low=5, size=100, endpoint=True)
|
||||
assert np.max(arr) == 5
|
||||
assert np.min(arr) == 0
|
||||
assert arr.shape == (100, )
|
||||
|
||||
# test that numbers are exclusive of high point
|
||||
arr = rng_integers(rng, low=2, high=5, size=100, endpoint=False)
|
||||
assert np.max(arr) == 4
|
||||
assert np.min(arr) == 2
|
||||
assert arr.shape == (100, )
|
||||
|
||||
# test that numbers are exclusive of high point
|
||||
arr = rng_integers(rng, low=5, size=100, endpoint=False)
|
||||
assert np.max(arr) == 4
|
||||
assert np.min(arr) == 0
|
||||
assert arr.shape == (100, )
|
||||
|
||||
|
||||
class TestValidateInt:
|
||||
|
||||
@pytest.mark.parametrize('n', [4, np.uint8(4), np.int16(4), np.array(4)])
|
||||
def test_validate_int(self, n):
|
||||
n = _validate_int(n, 'n')
|
||||
assert n == 4
|
||||
|
||||
@pytest.mark.parametrize('n', [4.0, np.array([4]), Fraction(4, 1)])
|
||||
def test_validate_int_bad(self, n):
|
||||
with pytest.raises(TypeError, match='n must be an integer'):
|
||||
_validate_int(n, 'n')
|
||||
|
||||
def test_validate_int_below_min(self):
|
||||
with pytest.raises(ValueError, match='n must be an integer not '
|
||||
'less than 0'):
|
||||
_validate_int(-1, 'n', 0)
|
||||
-163
@@ -1,163 +0,0 @@
|
||||
|
||||
import pytest
|
||||
import pickle
|
||||
from numpy.testing import assert_equal
|
||||
from scipy._lib._bunch import _make_tuple_bunch
|
||||
|
||||
|
||||
# `Result` is defined at the top level of the module so it can be
|
||||
# used to test pickling.
|
||||
Result = _make_tuple_bunch('Result', ['x', 'y', 'z'], ['w', 'beta'])
|
||||
|
||||
|
||||
class TestMakeTupleBunch:
|
||||
|
||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
# Tests with Result
|
||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
|
||||
def setup(self):
|
||||
# Set up an instance of Result.
|
||||
self.result = Result(x=1, y=2, z=3, w=99, beta=0.5)
|
||||
|
||||
def test_attribute_access(self):
|
||||
assert_equal(self.result.x, 1)
|
||||
assert_equal(self.result.y, 2)
|
||||
assert_equal(self.result.z, 3)
|
||||
assert_equal(self.result.w, 99)
|
||||
assert_equal(self.result.beta, 0.5)
|
||||
|
||||
def test_indexing(self):
|
||||
assert_equal(self.result[0], 1)
|
||||
assert_equal(self.result[1], 2)
|
||||
assert_equal(self.result[2], 3)
|
||||
assert_equal(self.result[-1], 3)
|
||||
with pytest.raises(IndexError, match='index out of range'):
|
||||
self.result[3]
|
||||
|
||||
def test_unpacking(self):
|
||||
x0, y0, z0 = self.result
|
||||
assert_equal((x0, y0, z0), (1, 2, 3))
|
||||
assert_equal(self.result, (1, 2, 3))
|
||||
|
||||
def test_slice(self):
|
||||
assert_equal(self.result[1:], (2, 3))
|
||||
assert_equal(self.result[::2], (1, 3))
|
||||
assert_equal(self.result[::-1], (3, 2, 1))
|
||||
|
||||
def test_len(self):
|
||||
assert_equal(len(self.result), 3)
|
||||
|
||||
def test_repr(self):
|
||||
s = repr(self.result)
|
||||
assert_equal(s, 'Result(x=1, y=2, z=3, w=99, beta=0.5)')
|
||||
|
||||
def test_hash(self):
|
||||
assert_equal(hash(self.result), hash((1, 2, 3)))
|
||||
|
||||
def test_pickle(self):
|
||||
s = pickle.dumps(self.result)
|
||||
obj = pickle.loads(s)
|
||||
assert isinstance(obj, Result)
|
||||
assert_equal(obj.x, self.result.x)
|
||||
assert_equal(obj.y, self.result.y)
|
||||
assert_equal(obj.z, self.result.z)
|
||||
assert_equal(obj.w, self.result.w)
|
||||
assert_equal(obj.beta, self.result.beta)
|
||||
|
||||
def test_read_only_existing(self):
|
||||
with pytest.raises(AttributeError, match="can't set attribute"):
|
||||
self.result.x = -1
|
||||
|
||||
def test_read_only_new(self):
|
||||
with pytest.raises(AttributeError, match="can't set attribute"):
|
||||
self.result.plate_of_shrimp = "lattice of coincidence"
|
||||
|
||||
def test_constructor_missing_parameter(self):
|
||||
with pytest.raises(TypeError, match='missing'):
|
||||
# `w` is missing.
|
||||
Result(x=1, y=2, z=3, beta=0.75)
|
||||
|
||||
def test_constructor_incorrect_parameter(self):
|
||||
with pytest.raises(TypeError, match='unexpected'):
|
||||
# `foo` is not an existing field.
|
||||
Result(x=1, y=2, z=3, w=123, beta=0.75, foo=999)
|
||||
|
||||
def test_module(self):
|
||||
m = 'scipy._lib.tests.test_bunch'
|
||||
assert_equal(Result.__module__, m)
|
||||
assert_equal(self.result.__module__, m)
|
||||
|
||||
def test_extra_fields_per_instance(self):
|
||||
# This test exists to ensure that instances of the same class
|
||||
# store their own values for the extra fields. That is, the values
|
||||
# are stored per instance and not in the class.
|
||||
result1 = Result(x=1, y=2, z=3, w=-1, beta=0.0)
|
||||
result2 = Result(x=4, y=5, z=6, w=99, beta=1.0)
|
||||
assert_equal(result1.w, -1)
|
||||
assert_equal(result1.beta, 0.0)
|
||||
# The rest of these checks aren't essential, but let's check
|
||||
# them anyway.
|
||||
assert_equal(result1[:], (1, 2, 3))
|
||||
assert_equal(result2.w, 99)
|
||||
assert_equal(result2.beta, 1.0)
|
||||
assert_equal(result2[:], (4, 5, 6))
|
||||
|
||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
# Other tests
|
||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
|
||||
def test_extra_field_names_is_optional(self):
|
||||
Square = _make_tuple_bunch('Square', ['width', 'height'])
|
||||
sq = Square(width=1, height=2)
|
||||
assert_equal(sq.width, 1)
|
||||
assert_equal(sq.height, 2)
|
||||
s = repr(sq)
|
||||
assert_equal(s, 'Square(width=1, height=2)')
|
||||
|
||||
def test_tuple_like(self):
|
||||
Tup = _make_tuple_bunch('Tup', ['a', 'b'])
|
||||
tu = Tup(a=1, b=2)
|
||||
assert isinstance(tu, tuple)
|
||||
assert isinstance(tu + (1,), tuple)
|
||||
|
||||
def test_explicit_module(self):
|
||||
m = 'some.module.name'
|
||||
Foo = _make_tuple_bunch('Foo', ['x'], ['a', 'b'], module=m)
|
||||
foo = Foo(x=1, a=355, b=113)
|
||||
assert_equal(Foo.__module__, m)
|
||||
assert_equal(foo.__module__, m)
|
||||
|
||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
# Argument validation
|
||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
|
||||
@pytest.mark.parametrize('args', [('123', ['a'], ['b']),
|
||||
('Foo', ['-3'], ['x']),
|
||||
('Foo', ['a'], ['+-*/'])])
|
||||
def test_identifiers_not_allowed(self, args):
|
||||
with pytest.raises(ValueError, match='identifiers'):
|
||||
_make_tuple_bunch(*args)
|
||||
|
||||
@pytest.mark.parametrize('args', [('Foo', ['a', 'b', 'a'], ['x']),
|
||||
('Foo', ['a', 'b'], ['b', 'x'])])
|
||||
def test_repeated_field_names(self, args):
|
||||
with pytest.raises(ValueError, match='Duplicate'):
|
||||
_make_tuple_bunch(*args)
|
||||
|
||||
@pytest.mark.parametrize('args', [('Foo', ['_a'], ['x']),
|
||||
('Foo', ['a'], ['_x'])])
|
||||
def test_leading_underscore_not_allowed(self, args):
|
||||
with pytest.raises(ValueError, match='underscore'):
|
||||
_make_tuple_bunch(*args)
|
||||
|
||||
@pytest.mark.parametrize('args', [('Foo', ['def'], ['x']),
|
||||
('Foo', ['a'], ['or']),
|
||||
('and', ['a'], ['x'])])
|
||||
def test_keyword_not_allowed_in_fields(self, args):
|
||||
with pytest.raises(ValueError, match='keyword'):
|
||||
_make_tuple_bunch(*args)
|
||||
|
||||
def test_at_least_one_field_name_required(self):
|
||||
with pytest.raises(ValueError, match='at least one name'):
|
||||
_make_tuple_bunch('Qwerty', [], ['a', 'b'])
|
||||
-197
@@ -1,197 +0,0 @@
|
||||
from numpy.testing import assert_equal, assert_
|
||||
from pytest import raises as assert_raises
|
||||
|
||||
import time
|
||||
import pytest
|
||||
import ctypes
|
||||
import threading
|
||||
from scipy._lib import _ccallback_c as _test_ccallback_cython
|
||||
from scipy._lib import _test_ccallback
|
||||
from scipy._lib._ccallback import LowLevelCallable
|
||||
|
||||
try:
|
||||
import cffi
|
||||
HAVE_CFFI = True
|
||||
except ImportError:
|
||||
HAVE_CFFI = False
|
||||
|
||||
|
||||
ERROR_VALUE = 2.0
|
||||
|
||||
|
||||
def callback_python(a, user_data=None):
|
||||
if a == ERROR_VALUE:
|
||||
raise ValueError("bad value")
|
||||
|
||||
if user_data is None:
|
||||
return a + 1
|
||||
else:
|
||||
return a + user_data
|
||||
|
||||
def _get_cffi_func(base, signature):
|
||||
if not HAVE_CFFI:
|
||||
pytest.skip("cffi not installed")
|
||||
|
||||
# Get function address
|
||||
voidp = ctypes.cast(base, ctypes.c_void_p)
|
||||
address = voidp.value
|
||||
|
||||
# Create corresponding cffi handle
|
||||
ffi = cffi.FFI()
|
||||
func = ffi.cast(signature, address)
|
||||
return func
|
||||
|
||||
|
||||
def _get_ctypes_data():
|
||||
value = ctypes.c_double(2.0)
|
||||
return ctypes.cast(ctypes.pointer(value), ctypes.c_voidp)
|
||||
|
||||
|
||||
def _get_cffi_data():
|
||||
if not HAVE_CFFI:
|
||||
pytest.skip("cffi not installed")
|
||||
ffi = cffi.FFI()
|
||||
return ffi.new('double *', 2.0)
|
||||
|
||||
|
||||
CALLERS = {
|
||||
'simple': _test_ccallback.test_call_simple,
|
||||
'nodata': _test_ccallback.test_call_nodata,
|
||||
'nonlocal': _test_ccallback.test_call_nonlocal,
|
||||
'cython': _test_ccallback_cython.test_call_cython,
|
||||
}
|
||||
|
||||
# These functions have signatures known to the callers
|
||||
FUNCS = {
|
||||
'python': lambda: callback_python,
|
||||
'capsule': lambda: _test_ccallback.test_get_plus1_capsule(),
|
||||
'cython': lambda: LowLevelCallable.from_cython(_test_ccallback_cython, "plus1_cython"),
|
||||
'ctypes': lambda: _test_ccallback_cython.plus1_ctypes,
|
||||
'cffi': lambda: _get_cffi_func(_test_ccallback_cython.plus1_ctypes,
|
||||
'double (*)(double, int *, void *)'),
|
||||
'capsule_b': lambda: _test_ccallback.test_get_plus1b_capsule(),
|
||||
'cython_b': lambda: LowLevelCallable.from_cython(_test_ccallback_cython, "plus1b_cython"),
|
||||
'ctypes_b': lambda: _test_ccallback_cython.plus1b_ctypes,
|
||||
'cffi_b': lambda: _get_cffi_func(_test_ccallback_cython.plus1b_ctypes,
|
||||
'double (*)(double, double, int *, void *)'),
|
||||
}
|
||||
|
||||
# These functions have signatures the callers don't know
|
||||
BAD_FUNCS = {
|
||||
'capsule_bc': lambda: _test_ccallback.test_get_plus1bc_capsule(),
|
||||
'cython_bc': lambda: LowLevelCallable.from_cython(_test_ccallback_cython, "plus1bc_cython"),
|
||||
'ctypes_bc': lambda: _test_ccallback_cython.plus1bc_ctypes,
|
||||
'cffi_bc': lambda: _get_cffi_func(_test_ccallback_cython.plus1bc_ctypes,
|
||||
'double (*)(double, double, double, int *, void *)'),
|
||||
}
|
||||
|
||||
USER_DATAS = {
|
||||
'ctypes': _get_ctypes_data,
|
||||
'cffi': _get_cffi_data,
|
||||
'capsule': _test_ccallback.test_get_data_capsule,
|
||||
}
|
||||
|
||||
|
||||
def test_callbacks():
|
||||
def check(caller, func, user_data):
|
||||
caller = CALLERS[caller]
|
||||
func = FUNCS[func]()
|
||||
user_data = USER_DATAS[user_data]()
|
||||
|
||||
if func is callback_python:
|
||||
func2 = lambda x: func(x, 2.0)
|
||||
else:
|
||||
func2 = LowLevelCallable(func, user_data)
|
||||
func = LowLevelCallable(func)
|
||||
|
||||
# Test basic call
|
||||
assert_equal(caller(func, 1.0), 2.0)
|
||||
|
||||
# Test 'bad' value resulting to an error
|
||||
assert_raises(ValueError, caller, func, ERROR_VALUE)
|
||||
|
||||
# Test passing in user_data
|
||||
assert_equal(caller(func2, 1.0), 3.0)
|
||||
|
||||
for caller in sorted(CALLERS.keys()):
|
||||
for func in sorted(FUNCS.keys()):
|
||||
for user_data in sorted(USER_DATAS.keys()):
|
||||
check(caller, func, user_data)
|
||||
|
||||
|
||||
def test_bad_callbacks():
|
||||
def check(caller, func, user_data):
|
||||
caller = CALLERS[caller]
|
||||
user_data = USER_DATAS[user_data]()
|
||||
func = BAD_FUNCS[func]()
|
||||
|
||||
if func is callback_python:
|
||||
func2 = lambda x: func(x, 2.0)
|
||||
else:
|
||||
func2 = LowLevelCallable(func, user_data)
|
||||
func = LowLevelCallable(func)
|
||||
|
||||
# Test that basic call fails
|
||||
assert_raises(ValueError, caller, LowLevelCallable(func), 1.0)
|
||||
|
||||
# Test that passing in user_data also fails
|
||||
assert_raises(ValueError, caller, func2, 1.0)
|
||||
|
||||
# Test error message
|
||||
llfunc = LowLevelCallable(func)
|
||||
try:
|
||||
caller(llfunc, 1.0)
|
||||
except ValueError as err:
|
||||
msg = str(err)
|
||||
assert_(llfunc.signature in msg, msg)
|
||||
assert_('double (double, double, int *, void *)' in msg, msg)
|
||||
|
||||
for caller in sorted(CALLERS.keys()):
|
||||
for func in sorted(BAD_FUNCS.keys()):
|
||||
for user_data in sorted(USER_DATAS.keys()):
|
||||
check(caller, func, user_data)
|
||||
|
||||
|
||||
def test_signature_override():
|
||||
caller = _test_ccallback.test_call_simple
|
||||
func = _test_ccallback.test_get_plus1_capsule()
|
||||
|
||||
llcallable = LowLevelCallable(func, signature="bad signature")
|
||||
assert_equal(llcallable.signature, "bad signature")
|
||||
assert_raises(ValueError, caller, llcallable, 3)
|
||||
|
||||
llcallable = LowLevelCallable(func, signature="double (double, int *, void *)")
|
||||
assert_equal(llcallable.signature, "double (double, int *, void *)")
|
||||
assert_equal(caller(llcallable, 3), 4)
|
||||
|
||||
|
||||
def test_threadsafety():
|
||||
def callback(a, caller):
|
||||
if a <= 0:
|
||||
return 1
|
||||
else:
|
||||
res = caller(lambda x: callback(x, caller), a - 1)
|
||||
return 2*res
|
||||
|
||||
def check(caller):
|
||||
caller = CALLERS[caller]
|
||||
|
||||
results = []
|
||||
|
||||
count = 10
|
||||
|
||||
def run():
|
||||
time.sleep(0.01)
|
||||
r = caller(lambda x: callback(x, caller), count)
|
||||
results.append(r)
|
||||
|
||||
threads = [threading.Thread(target=run) for j in range(20)]
|
||||
for thread in threads:
|
||||
thread.start()
|
||||
for thread in threads:
|
||||
thread.join()
|
||||
|
||||
assert_equal(results, [2.0**count]*len(threads))
|
||||
|
||||
for caller in CALLERS.keys():
|
||||
check(caller)
|
||||
@@ -1,10 +0,0 @@
|
||||
import pytest
|
||||
|
||||
|
||||
def test_cython_api_deprecation():
|
||||
match = ("`scipy._lib._test_deprecation_def.foo_deprecated` "
|
||||
"is deprecated, use `foo` instead!\n"
|
||||
"Deprecated in Scipy 42.0.0")
|
||||
with pytest.warns(DeprecationWarning, match=match):
|
||||
from .. import _test_deprecation_call
|
||||
assert _test_deprecation_call.call() == (1, 1)
|
||||
@@ -1,53 +0,0 @@
|
||||
import sys
|
||||
import subprocess
|
||||
|
||||
|
||||
MODULES = [
|
||||
"scipy.cluster",
|
||||
"scipy.cluster.vq",
|
||||
"scipy.cluster.hierarchy",
|
||||
"scipy.constants",
|
||||
"scipy.fft",
|
||||
"scipy.fftpack",
|
||||
"scipy.fftpack.convolve",
|
||||
"scipy.integrate",
|
||||
"scipy.interpolate",
|
||||
"scipy.io",
|
||||
"scipy.io.arff",
|
||||
"scipy.io.harwell_boeing",
|
||||
"scipy.io.idl",
|
||||
"scipy.io.matlab",
|
||||
"scipy.io.netcdf",
|
||||
"scipy.io.wavfile",
|
||||
"scipy.linalg",
|
||||
"scipy.linalg.blas",
|
||||
"scipy.linalg.cython_blas",
|
||||
"scipy.linalg.lapack",
|
||||
"scipy.linalg.cython_lapack",
|
||||
"scipy.linalg.interpolative",
|
||||
"scipy.misc",
|
||||
"scipy.ndimage",
|
||||
"scipy.odr",
|
||||
"scipy.optimize",
|
||||
"scipy.signal",
|
||||
"scipy.signal.windows",
|
||||
"scipy.sparse",
|
||||
"scipy.sparse.linalg",
|
||||
"scipy.sparse.csgraph",
|
||||
"scipy.spatial",
|
||||
"scipy.spatial.distance",
|
||||
"scipy.special",
|
||||
"scipy.stats",
|
||||
"scipy.stats.distributions",
|
||||
"scipy.stats.mstats",
|
||||
"scipy.stats.contingency"
|
||||
]
|
||||
|
||||
|
||||
def test_modules_importable():
|
||||
# Regression test for gh-6793.
|
||||
# Check that all modules are importable in a new Python process.
|
||||
# This is not necessarily true if there are import cycles present.
|
||||
for module in MODULES:
|
||||
cmd = 'import {}'.format(module)
|
||||
subprocess.check_call([sys.executable, '-c', cmd])
|
||||
-42
@@ -1,42 +0,0 @@
|
||||
""" Test tmpdirs module """
|
||||
from os import getcwd
|
||||
from os.path import realpath, abspath, dirname, isfile, join as pjoin, exists
|
||||
|
||||
from scipy._lib._tmpdirs import tempdir, in_tempdir, in_dir
|
||||
|
||||
from numpy.testing import assert_, assert_equal
|
||||
|
||||
MY_PATH = abspath(__file__)
|
||||
MY_DIR = dirname(MY_PATH)
|
||||
|
||||
|
||||
def test_tempdir():
|
||||
with tempdir() as tmpdir:
|
||||
fname = pjoin(tmpdir, 'example_file.txt')
|
||||
with open(fname, 'wt') as fobj:
|
||||
fobj.write('a string\\n')
|
||||
assert_(not exists(tmpdir))
|
||||
|
||||
|
||||
def test_in_tempdir():
|
||||
my_cwd = getcwd()
|
||||
with in_tempdir() as tmpdir:
|
||||
with open('test.txt', 'wt') as f:
|
||||
f.write('some text')
|
||||
assert_(isfile('test.txt'))
|
||||
assert_(isfile(pjoin(tmpdir, 'test.txt')))
|
||||
assert_(not exists(tmpdir))
|
||||
assert_equal(getcwd(), my_cwd)
|
||||
|
||||
|
||||
def test_given_directory():
|
||||
# Test InGivenDirectory
|
||||
cwd = getcwd()
|
||||
with in_dir() as tmpdir:
|
||||
assert_equal(tmpdir, abspath(cwd))
|
||||
assert_equal(tmpdir, abspath(getcwd()))
|
||||
with in_dir(MY_DIR) as tmpdir:
|
||||
assert_equal(tmpdir, MY_DIR)
|
||||
assert_equal(realpath(MY_DIR), realpath(abspath(getcwd())))
|
||||
# We were deleting the given directory! Check not so now.
|
||||
assert_(isfile(MY_PATH))
|
||||
-121
@@ -1,121 +0,0 @@
|
||||
"""
|
||||
Tests which scan for certain occurrences in the code, they may not find
|
||||
all of these occurrences but should catch almost all. This file was adapted
|
||||
from NumPy.
|
||||
"""
|
||||
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import ast
|
||||
import tokenize
|
||||
|
||||
import scipy
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
class ParseCall(ast.NodeVisitor):
|
||||
def __init__(self):
|
||||
self.ls = []
|
||||
|
||||
def visit_Attribute(self, node):
|
||||
ast.NodeVisitor.generic_visit(self, node)
|
||||
self.ls.append(node.attr)
|
||||
|
||||
def visit_Name(self, node):
|
||||
self.ls.append(node.id)
|
||||
|
||||
class FindFuncs(ast.NodeVisitor):
|
||||
def __init__(self, filename):
|
||||
super().__init__()
|
||||
self.__filename = filename
|
||||
self.bad_filters = []
|
||||
self.bad_stacklevels = []
|
||||
|
||||
def visit_Call(self, node):
|
||||
p = ParseCall()
|
||||
p.visit(node.func)
|
||||
ast.NodeVisitor.generic_visit(self, node)
|
||||
|
||||
if p.ls[-1] == 'simplefilter' or p.ls[-1] == 'filterwarnings':
|
||||
if node.args[0].s == "ignore":
|
||||
self.bad_filters.append(
|
||||
"{}:{}".format(self.__filename, node.lineno))
|
||||
|
||||
if p.ls[-1] == 'warn' and (
|
||||
len(p.ls) == 1 or p.ls[-2] == 'warnings'):
|
||||
|
||||
if self.__filename == "_lib/tests/test_warnings.py":
|
||||
# This file
|
||||
return
|
||||
|
||||
# See if stacklevel exists:
|
||||
if len(node.args) == 3:
|
||||
return
|
||||
args = {kw.arg for kw in node.keywords}
|
||||
if "stacklevel" not in args:
|
||||
self.bad_stacklevels.append(
|
||||
"{}:{}".format(self.__filename, node.lineno))
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def warning_calls():
|
||||
# combined "ignore" and stacklevel error
|
||||
base = Path(scipy.__file__).parent
|
||||
|
||||
bad_filters = []
|
||||
bad_stacklevels = []
|
||||
|
||||
for path in base.rglob("*.py"):
|
||||
# use tokenize to auto-detect encoding on systems where no
|
||||
# default encoding is defined (e.g., LANG='C')
|
||||
with tokenize.open(str(path)) as file:
|
||||
tree = ast.parse(file.read(), filename=str(path))
|
||||
finder = FindFuncs(path.relative_to(base))
|
||||
finder.visit(tree)
|
||||
bad_filters.extend(finder.bad_filters)
|
||||
bad_stacklevels.extend(finder.bad_stacklevels)
|
||||
|
||||
return bad_filters, bad_stacklevels
|
||||
|
||||
|
||||
@pytest.mark.slow
|
||||
def test_warning_calls_filters(warning_calls):
|
||||
bad_filters, bad_stacklevels = warning_calls
|
||||
|
||||
# There is still one simplefilter occurrence in optimize.py that could be removed.
|
||||
bad_filters = [item for item in bad_filters
|
||||
if 'optimize.py' not in item]
|
||||
# The filterwarnings calls in sparse are needed.
|
||||
bad_filters = [item for item in bad_filters
|
||||
if os.path.join('sparse', '__init__.py') not in item
|
||||
and os.path.join('sparse', 'sputils.py') not in item]
|
||||
|
||||
if bad_filters:
|
||||
raise AssertionError(
|
||||
"warning ignore filter should not be used, instead, use\n"
|
||||
"numpy.testing.suppress_warnings (in tests only);\n"
|
||||
"found in:\n {}".format(
|
||||
"\n ".join(bad_filters)))
|
||||
|
||||
|
||||
@pytest.mark.slow
|
||||
@pytest.mark.xfail(reason="stacklevels currently missing")
|
||||
def test_warning_calls_stacklevels(warning_calls):
|
||||
bad_filters, bad_stacklevels = warning_calls
|
||||
|
||||
msg = ""
|
||||
|
||||
if bad_filters:
|
||||
msg += ("warning ignore filter should not be used, instead, use\n"
|
||||
"numpy.testing.suppress_warnings (in tests only);\n"
|
||||
"found in:\n {}".format("\n ".join(bad_filters)))
|
||||
msg += "\n\n"
|
||||
|
||||
if bad_stacklevels:
|
||||
msg += "warnings should have an appropriate stacklevel:\n {}".format(
|
||||
"\n ".join(bad_stacklevels))
|
||||
|
||||
if msg:
|
||||
raise AssertionError(msg)
|
||||
Vendored
-31
@@ -1,31 +0,0 @@
|
||||
"""`uarray` provides functions for generating multimethods that dispatch to
|
||||
multiple different backends
|
||||
|
||||
This should be imported, rather than `_uarray` so that an installed version could
|
||||
be used instead, if available. This means that users can call
|
||||
`uarray.set_backend` directly instead of going through SciPy.
|
||||
|
||||
"""
|
||||
|
||||
|
||||
# Prefer an installed version of uarray, if available
|
||||
try:
|
||||
import uarray as _uarray
|
||||
except ImportError:
|
||||
_has_uarray = False
|
||||
else:
|
||||
from scipy._lib._pep440 import Version as _Version
|
||||
|
||||
_has_uarray = _Version(_uarray.__version__) >= _Version("0.5")
|
||||
del _uarray
|
||||
del _Version
|
||||
|
||||
|
||||
if _has_uarray:
|
||||
from uarray import *
|
||||
from uarray import _Function
|
||||
else:
|
||||
from ._uarray import *
|
||||
from ._uarray import _Function
|
||||
|
||||
del _has_uarray
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
"""
|
||||
=========================================
|
||||
Clustering package (:mod:`scipy.cluster`)
|
||||
=========================================
|
||||
|
||||
.. currentmodule:: scipy.cluster
|
||||
|
||||
:mod:`scipy.cluster.vq`
|
||||
|
||||
Clustering algorithms are useful in information theory, target detection,
|
||||
communications, compression, and other areas. The `vq` module only
|
||||
supports vector quantization and the k-means algorithms.
|
||||
|
||||
:mod:`scipy.cluster.hierarchy`
|
||||
|
||||
The `hierarchy` module provides functions for hierarchical and
|
||||
agglomerative clustering. Its features include generating hierarchical
|
||||
clusters from distance matrices,
|
||||
calculating statistics on clusters, cutting linkages
|
||||
to generate flat clusters, and visualizing clusters with dendrograms.
|
||||
|
||||
"""
|
||||
__all__ = ['vq', 'hierarchy']
|
||||
|
||||
from . import vq, hierarchy
|
||||
|
||||
from scipy._lib._testutils import PytestTester
|
||||
test = PytestTester(__name__)
|
||||
del PytestTester
|
||||
-4175
File diff suppressed because it is too large
Load Diff
Vendored
-27
@@ -1,27 +0,0 @@
|
||||
DEFINE_MACROS = [("SCIPY_PY3K", None)]
|
||||
|
||||
|
||||
def configuration(parent_package='', top_path=None):
|
||||
from numpy.distutils.misc_util import Configuration, get_numpy_include_dirs
|
||||
config = Configuration('cluster', parent_package, top_path)
|
||||
|
||||
config.add_data_dir('tests')
|
||||
|
||||
config.add_extension('_vq',
|
||||
sources=[('_vq.c')],
|
||||
include_dirs=[get_numpy_include_dirs()])
|
||||
|
||||
config.add_extension('_hierarchy',
|
||||
sources=[('_hierarchy.c')],
|
||||
include_dirs=[get_numpy_include_dirs()])
|
||||
|
||||
config.add_extension('_optimal_leaf_ordering',
|
||||
sources=[('_optimal_leaf_ordering.c')],
|
||||
include_dirs=[get_numpy_include_dirs()])
|
||||
|
||||
return config
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
from numpy.distutils.core import setup
|
||||
setup(**configuration(top_path='').todict())
|
||||
@@ -1,145 +0,0 @@
|
||||
from numpy import array
|
||||
|
||||
|
||||
Q_X = array([[5.26563660e-01, 3.14160190e-01, 8.00656370e-02],
|
||||
[7.50205180e-01, 4.60299830e-01, 8.98696460e-01],
|
||||
[6.65461230e-01, 6.94011420e-01, 9.10465700e-01],
|
||||
[9.64047590e-01, 1.43082200e-03, 7.39874220e-01],
|
||||
[1.08159060e-01, 5.53028790e-01, 6.63804780e-02],
|
||||
[9.31359130e-01, 8.25424910e-01, 9.52315440e-01],
|
||||
[6.78086960e-01, 3.41903970e-01, 5.61481950e-01],
|
||||
[9.82730940e-01, 7.04605210e-01, 8.70978630e-02],
|
||||
[6.14691610e-01, 4.69989230e-02, 6.02406450e-01],
|
||||
[5.80161260e-01, 9.17354970e-01, 5.88163850e-01],
|
||||
[1.38246310e+00, 1.96358160e+00, 1.94437880e+00],
|
||||
[2.10675860e+00, 1.67148730e+00, 1.34854480e+00],
|
||||
[1.39880070e+00, 1.66142050e+00, 1.32224550e+00],
|
||||
[1.71410460e+00, 1.49176380e+00, 1.45432170e+00],
|
||||
[1.54102340e+00, 1.84374950e+00, 1.64658950e+00],
|
||||
[2.08512480e+00, 1.84524350e+00, 2.17340850e+00],
|
||||
[1.30748740e+00, 1.53801650e+00, 2.16007740e+00],
|
||||
[1.41447700e+00, 1.99329070e+00, 1.99107420e+00],
|
||||
[1.61943490e+00, 1.47703280e+00, 1.89788160e+00],
|
||||
[1.59880600e+00, 1.54988980e+00, 1.57563350e+00],
|
||||
[3.37247380e+00, 2.69635310e+00, 3.39981700e+00],
|
||||
[3.13705120e+00, 3.36528090e+00, 3.06089070e+00],
|
||||
[3.29413250e+00, 3.19619500e+00, 2.90700170e+00],
|
||||
[2.65510510e+00, 3.06785900e+00, 2.97198540e+00],
|
||||
[3.30941040e+00, 2.59283970e+00, 2.57714110e+00],
|
||||
[2.59557220e+00, 3.33477370e+00, 3.08793190e+00],
|
||||
[2.58206180e+00, 3.41615670e+00, 3.26441990e+00],
|
||||
[2.71127000e+00, 2.77032450e+00, 2.63466500e+00],
|
||||
[2.79617850e+00, 3.25473720e+00, 3.41801560e+00],
|
||||
[2.64741750e+00, 2.54538040e+00, 3.25354110e+00]])
|
||||
|
||||
ytdist = array([662., 877., 255., 412., 996., 295., 468., 268., 400., 754.,
|
||||
564., 138., 219., 869., 669.])
|
||||
|
||||
linkage_ytdist_single = array([[2., 5., 138., 2.],
|
||||
[3., 4., 219., 2.],
|
||||
[0., 7., 255., 3.],
|
||||
[1., 8., 268., 4.],
|
||||
[6., 9., 295., 6.]])
|
||||
|
||||
linkage_ytdist_complete = array([[2., 5., 138., 2.],
|
||||
[3., 4., 219., 2.],
|
||||
[1., 6., 400., 3.],
|
||||
[0., 7., 412., 3.],
|
||||
[8., 9., 996., 6.]])
|
||||
|
||||
linkage_ytdist_average = array([[2., 5., 138., 2.],
|
||||
[3., 4., 219., 2.],
|
||||
[0., 7., 333.5, 3.],
|
||||
[1., 6., 347.5, 3.],
|
||||
[8., 9., 680.77777778, 6.]])
|
||||
|
||||
linkage_ytdist_weighted = array([[2., 5., 138., 2.],
|
||||
[3., 4., 219., 2.],
|
||||
[0., 7., 333.5, 3.],
|
||||
[1., 6., 347.5, 3.],
|
||||
[8., 9., 670.125, 6.]])
|
||||
|
||||
# the optimal leaf ordering of linkage_ytdist_single
|
||||
linkage_ytdist_single_olo = array([[5., 2., 138., 2.],
|
||||
[4., 3., 219., 2.],
|
||||
[7., 0., 255., 3.],
|
||||
[1., 8., 268., 4.],
|
||||
[6., 9., 295., 6.]])
|
||||
|
||||
X = array([[1.43054825, -7.5693489],
|
||||
[6.95887839, 6.82293382],
|
||||
[2.87137846, -9.68248579],
|
||||
[7.87974764, -6.05485803],
|
||||
[8.24018364, -6.09495602],
|
||||
[7.39020262, 8.54004355]])
|
||||
|
||||
linkage_X_centroid = array([[3., 4., 0.36265956, 2.],
|
||||
[1., 5., 1.77045373, 2.],
|
||||
[0., 2., 2.55760419, 2.],
|
||||
[6., 8., 6.43614494, 4.],
|
||||
[7., 9., 15.17363237, 6.]])
|
||||
|
||||
linkage_X_median = array([[3., 4., 0.36265956, 2.],
|
||||
[1., 5., 1.77045373, 2.],
|
||||
[0., 2., 2.55760419, 2.],
|
||||
[6., 8., 6.43614494, 4.],
|
||||
[7., 9., 15.17363237, 6.]])
|
||||
|
||||
linkage_X_ward = array([[3., 4., 0.36265956, 2.],
|
||||
[1., 5., 1.77045373, 2.],
|
||||
[0., 2., 2.55760419, 2.],
|
||||
[6., 8., 9.10208346, 4.],
|
||||
[7., 9., 24.7784379, 6.]])
|
||||
|
||||
# the optimal leaf ordering of linkage_X_ward
|
||||
linkage_X_ward_olo = array([[4., 3., 0.36265956, 2.],
|
||||
[5., 1., 1.77045373, 2.],
|
||||
[2., 0., 2.55760419, 2.],
|
||||
[6., 8., 9.10208346, 4.],
|
||||
[7., 9., 24.7784379, 6.]])
|
||||
|
||||
inconsistent_ytdist = {
|
||||
1: array([[138., 0., 1., 0.],
|
||||
[219., 0., 1., 0.],
|
||||
[255., 0., 1., 0.],
|
||||
[268., 0., 1., 0.],
|
||||
[295., 0., 1., 0.]]),
|
||||
2: array([[138., 0., 1., 0.],
|
||||
[219., 0., 1., 0.],
|
||||
[237., 25.45584412, 2., 0.70710678],
|
||||
[261.5, 9.19238816, 2., 0.70710678],
|
||||
[233.66666667, 83.9424406, 3., 0.7306594]]),
|
||||
3: array([[138., 0., 1., 0.],
|
||||
[219., 0., 1., 0.],
|
||||
[237., 25.45584412, 2., 0.70710678],
|
||||
[247.33333333, 25.38372182, 3., 0.81417007],
|
||||
[239., 69.36377537, 4., 0.80733783]]),
|
||||
4: array([[138., 0., 1., 0.],
|
||||
[219., 0., 1., 0.],
|
||||
[237., 25.45584412, 2., 0.70710678],
|
||||
[247.33333333, 25.38372182, 3., 0.81417007],
|
||||
[235., 60.73302232, 5., 0.98793042]])}
|
||||
|
||||
fcluster_inconsistent = {
|
||||
0.8: array([6, 2, 2, 4, 6, 2, 3, 7, 3, 5, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 1,
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1]),
|
||||
1.0: array([6, 2, 2, 4, 6, 2, 3, 7, 3, 5, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 1,
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1]),
|
||||
2.0: array([1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1])}
|
||||
|
||||
fcluster_distance = {
|
||||
0.6: array([4, 4, 4, 4, 4, 4, 4, 5, 4, 4, 6, 6, 6, 6, 6, 7, 6, 6, 6, 6, 3,
|
||||
1, 1, 1, 2, 1, 1, 1, 1, 1]),
|
||||
1.0: array([2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 1,
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1]),
|
||||
2.0: array([1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1])}
|
||||
|
||||
fcluster_maxclust = {
|
||||
8.0: array([5, 5, 5, 5, 5, 5, 5, 6, 5, 5, 7, 7, 7, 7, 7, 8, 7, 7, 7, 7, 4,
|
||||
1, 1, 1, 3, 1, 1, 1, 1, 2]),
|
||||
4.0: array([3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 2,
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1]),
|
||||
1.0: array([1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1])}
|
||||
@@ -1,201 +0,0 @@
|
||||
import pytest
|
||||
from pytest import raises as assert_raises
|
||||
import numpy as np
|
||||
from scipy.cluster.hierarchy import DisjointSet
|
||||
import string
|
||||
|
||||
|
||||
def generate_random_token():
|
||||
k = len(string.ascii_letters)
|
||||
tokens = list(np.arange(k, dtype=int))
|
||||
tokens += list(np.arange(k, dtype=float))
|
||||
tokens += list(string.ascii_letters)
|
||||
tokens += [None for i in range(k)]
|
||||
tokens = np.array(tokens, dtype=object)
|
||||
rng = np.random.RandomState(seed=0)
|
||||
|
||||
while 1:
|
||||
size = rng.randint(1, 3)
|
||||
element = rng.choice(tokens, size)
|
||||
if size == 1:
|
||||
yield element[0]
|
||||
else:
|
||||
yield tuple(element)
|
||||
|
||||
|
||||
def get_elements(n):
|
||||
# dict is deterministic without difficulty of comparing numpy ints
|
||||
elements = {}
|
||||
for element in generate_random_token():
|
||||
if element not in elements:
|
||||
elements[element] = len(elements)
|
||||
if len(elements) >= n:
|
||||
break
|
||||
return list(elements.keys())
|
||||
|
||||
|
||||
def test_init():
|
||||
n = 10
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
assert dis.n_subsets == n
|
||||
assert list(dis) == elements
|
||||
|
||||
|
||||
def test_len():
|
||||
n = 10
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
assert len(dis) == n
|
||||
|
||||
dis.add("dummy")
|
||||
assert len(dis) == n + 1
|
||||
|
||||
|
||||
@pytest.mark.parametrize("n", [10, 100])
|
||||
def test_contains(n):
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
for x in elements:
|
||||
assert x in dis
|
||||
|
||||
assert "dummy" not in dis
|
||||
|
||||
|
||||
@pytest.mark.parametrize("n", [10, 100])
|
||||
def test_add(n):
|
||||
elements = get_elements(n)
|
||||
dis1 = DisjointSet(elements)
|
||||
|
||||
dis2 = DisjointSet()
|
||||
for i, x in enumerate(elements):
|
||||
dis2.add(x)
|
||||
assert len(dis2) == i + 1
|
||||
|
||||
# test idempotency by adding element again
|
||||
dis2.add(x)
|
||||
assert len(dis2) == i + 1
|
||||
|
||||
assert list(dis1) == list(dis2)
|
||||
|
||||
|
||||
def test_element_not_present():
|
||||
elements = get_elements(n=10)
|
||||
dis = DisjointSet(elements)
|
||||
|
||||
with assert_raises(KeyError):
|
||||
dis["dummy"]
|
||||
|
||||
with assert_raises(KeyError):
|
||||
dis.merge(elements[0], "dummy")
|
||||
|
||||
with assert_raises(KeyError):
|
||||
dis.connected(elements[0], "dummy")
|
||||
|
||||
|
||||
@pytest.mark.parametrize("direction", ["forwards", "backwards"])
|
||||
@pytest.mark.parametrize("n", [10, 100])
|
||||
def test_linear_union_sequence(n, direction):
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
assert elements == list(dis)
|
||||
|
||||
indices = list(range(n - 1))
|
||||
if direction == "backwards":
|
||||
indices = indices[::-1]
|
||||
|
||||
for it, i in enumerate(indices):
|
||||
assert not dis.connected(elements[i], elements[i + 1])
|
||||
assert dis.merge(elements[i], elements[i + 1])
|
||||
assert dis.connected(elements[i], elements[i + 1])
|
||||
assert dis.n_subsets == n - 1 - it
|
||||
|
||||
roots = [dis[i] for i in elements]
|
||||
if direction == "forwards":
|
||||
assert all(elements[0] == r for r in roots)
|
||||
else:
|
||||
assert all(elements[-2] == r for r in roots)
|
||||
assert not dis.merge(elements[0], elements[-1])
|
||||
|
||||
|
||||
@pytest.mark.parametrize("n", [10, 100])
|
||||
def test_self_unions(n):
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
|
||||
for x in elements:
|
||||
assert dis.connected(x, x)
|
||||
assert not dis.merge(x, x)
|
||||
assert dis.connected(x, x)
|
||||
assert dis.n_subsets == len(elements)
|
||||
|
||||
assert elements == list(dis)
|
||||
roots = [dis[x] for x in elements]
|
||||
assert elements == roots
|
||||
|
||||
|
||||
@pytest.mark.parametrize("order", ["ab", "ba"])
|
||||
@pytest.mark.parametrize("n", [10, 100])
|
||||
def test_equal_size_ordering(n, order):
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
|
||||
rng = np.random.RandomState(seed=0)
|
||||
indices = np.arange(n)
|
||||
rng.shuffle(indices)
|
||||
|
||||
for i in range(0, len(indices), 2):
|
||||
a, b = elements[indices[i]], elements[indices[i + 1]]
|
||||
if order == "ab":
|
||||
assert dis.merge(a, b)
|
||||
else:
|
||||
assert dis.merge(b, a)
|
||||
|
||||
expected = elements[min(indices[i], indices[i + 1])]
|
||||
assert dis[a] == expected
|
||||
assert dis[b] == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize("kmax", [5, 10])
|
||||
def test_binary_tree(kmax):
|
||||
n = 2**kmax
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
rng = np.random.RandomState(seed=0)
|
||||
|
||||
for k in 2**np.arange(kmax):
|
||||
for i in range(0, n, 2 * k):
|
||||
r1, r2 = rng.randint(0, k, size=2)
|
||||
a, b = elements[i + r1], elements[i + k + r2]
|
||||
assert not dis.connected(a, b)
|
||||
assert dis.merge(a, b)
|
||||
assert dis.connected(a, b)
|
||||
|
||||
assert elements == list(dis)
|
||||
roots = [dis[i] for i in elements]
|
||||
expected_indices = np.arange(n) - np.arange(n) % (2 * k)
|
||||
expected = [elements[i] for i in expected_indices]
|
||||
assert roots == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize("n", [10, 100])
|
||||
def test_subsets(n):
|
||||
elements = get_elements(n)
|
||||
dis = DisjointSet(elements)
|
||||
|
||||
rng = np.random.RandomState(seed=0)
|
||||
for i, j in rng.randint(0, n, (n, 2)):
|
||||
x = elements[i]
|
||||
y = elements[j]
|
||||
|
||||
expected = {element for element in dis if {dis[element]} == {dis[x]}}
|
||||
assert expected == dis.subset(x)
|
||||
|
||||
expected = {dis[element]: set() for element in dis}
|
||||
for element in dis:
|
||||
expected[dis[element]].add(element)
|
||||
expected = list(expected.values())
|
||||
assert expected == dis.subsets()
|
||||
|
||||
dis.merge(x, y)
|
||||
assert dis.subset(x) == dis.subset(y)
|
||||
-1091
File diff suppressed because it is too large
Load Diff
-336
@@ -1,336 +0,0 @@
|
||||
|
||||
import warnings
|
||||
import sys
|
||||
|
||||
import numpy as np
|
||||
from numpy.testing import (assert_array_equal, assert_array_almost_equal,
|
||||
assert_allclose, assert_equal, assert_,
|
||||
suppress_warnings)
|
||||
import pytest
|
||||
from pytest import raises as assert_raises
|
||||
|
||||
from scipy.cluster.vq import (kmeans, kmeans2, py_vq, vq, whiten,
|
||||
ClusterError, _krandinit)
|
||||
from scipy.cluster import _vq
|
||||
from scipy.sparse.sputils import matrix
|
||||
|
||||
|
||||
TESTDATA_2D = np.array([
|
||||
-2.2, 1.17, -1.63, 1.69, -2.04, 4.38, -3.09, 0.95, -1.7, 4.79, -1.68, 0.68,
|
||||
-2.26, 3.34, -2.29, 2.55, -1.72, -0.72, -1.99, 2.34, -2.75, 3.43, -2.45,
|
||||
2.41, -4.26, 3.65, -1.57, 1.87, -1.96, 4.03, -3.01, 3.86, -2.53, 1.28,
|
||||
-4.0, 3.95, -1.62, 1.25, -3.42, 3.17, -1.17, 0.12, -3.03, -0.27, -2.07,
|
||||
-0.55, -1.17, 1.34, -2.82, 3.08, -2.44, 0.24, -1.71, 2.48, -5.23, 4.29,
|
||||
-2.08, 3.69, -1.89, 3.62, -2.09, 0.26, -0.92, 1.07, -2.25, 0.88, -2.25,
|
||||
2.02, -4.31, 3.86, -2.03, 3.42, -2.76, 0.3, -2.48, -0.29, -3.42, 3.21,
|
||||
-2.3, 1.73, -2.84, 0.69, -1.81, 2.48, -5.24, 4.52, -2.8, 1.31, -1.67,
|
||||
-2.34, -1.18, 2.17, -2.17, 2.82, -1.85, 2.25, -2.45, 1.86, -6.79, 3.94,
|
||||
-2.33, 1.89, -1.55, 2.08, -1.36, 0.93, -2.51, 2.74, -2.39, 3.92, -3.33,
|
||||
2.99, -2.06, -0.9, -2.83, 3.35, -2.59, 3.05, -2.36, 1.85, -1.69, 1.8,
|
||||
-1.39, 0.66, -2.06, 0.38, -1.47, 0.44, -4.68, 3.77, -5.58, 3.44, -2.29,
|
||||
2.24, -1.04, -0.38, -1.85, 4.23, -2.88, 0.73, -2.59, 1.39, -1.34, 1.75,
|
||||
-1.95, 1.3, -2.45, 3.09, -1.99, 3.41, -5.55, 5.21, -1.73, 2.52, -2.17,
|
||||
0.85, -2.06, 0.49, -2.54, 2.07, -2.03, 1.3, -3.23, 3.09, -1.55, 1.44,
|
||||
-0.81, 1.1, -2.99, 2.92, -1.59, 2.18, -2.45, -0.73, -3.12, -1.3, -2.83,
|
||||
0.2, -2.77, 3.24, -1.98, 1.6, -4.59, 3.39, -4.85, 3.75, -2.25, 1.71, -3.28,
|
||||
3.38, -1.74, 0.88, -2.41, 1.92, -2.24, 1.19, -2.48, 1.06, -1.68, -0.62,
|
||||
-1.3, 0.39, -1.78, 2.35, -3.54, 2.44, -1.32, 0.66, -2.38, 2.76, -2.35,
|
||||
3.95, -1.86, 4.32, -2.01, -1.23, -1.79, 2.76, -2.13, -0.13, -5.25, 3.84,
|
||||
-2.24, 1.59, -4.85, 2.96, -2.41, 0.01, -0.43, 0.13, -3.92, 2.91, -1.75,
|
||||
-0.53, -1.69, 1.69, -1.09, 0.15, -2.11, 2.17, -1.53, 1.22, -2.1, -0.86,
|
||||
-2.56, 2.28, -3.02, 3.33, -1.12, 3.86, -2.18, -1.19, -3.03, 0.79, -0.83,
|
||||
0.97, -3.19, 1.45, -1.34, 1.28, -2.52, 4.22, -4.53, 3.22, -1.97, 1.75,
|
||||
-2.36, 3.19, -0.83, 1.53, -1.59, 1.86, -2.17, 2.3, -1.63, 2.71, -2.03,
|
||||
3.75, -2.57, -0.6, -1.47, 1.33, -1.95, 0.7, -1.65, 1.27, -1.42, 1.09, -3.0,
|
||||
3.87, -2.51, 3.06, -2.6, 0.74, -1.08, -0.03, -2.44, 1.31, -2.65, 2.99,
|
||||
-1.84, 1.65, -4.76, 3.75, -2.07, 3.98, -2.4, 2.67, -2.21, 1.49, -1.21,
|
||||
1.22, -5.29, 2.38, -2.85, 2.28, -5.6, 3.78, -2.7, 0.8, -1.81, 3.5, -3.75,
|
||||
4.17, -1.29, 2.99, -5.92, 3.43, -1.83, 1.23, -1.24, -1.04, -2.56, 2.37,
|
||||
-3.26, 0.39, -4.63, 2.51, -4.52, 3.04, -1.7, 0.36, -1.41, 0.04, -2.1, 1.0,
|
||||
-1.87, 3.78, -4.32, 3.59, -2.24, 1.38, -1.99, -0.22, -1.87, 1.95, -0.84,
|
||||
2.17, -5.38, 3.56, -1.27, 2.9, -1.79, 3.31, -5.47, 3.85, -1.44, 3.69,
|
||||
-2.02, 0.37, -1.29, 0.33, -2.34, 2.56, -1.74, -1.27, -1.97, 1.22, -2.51,
|
||||
-0.16, -1.64, -0.96, -2.99, 1.4, -1.53, 3.31, -2.24, 0.45, -2.46, 1.71,
|
||||
-2.88, 1.56, -1.63, 1.46, -1.41, 0.68, -1.96, 2.76, -1.61,
|
||||
2.11]).reshape((200, 2))
|
||||
|
||||
|
||||
# Global data
|
||||
X = np.array([[3.0, 3], [4, 3], [4, 2],
|
||||
[9, 2], [5, 1], [6, 2], [9, 4],
|
||||
[5, 2], [5, 4], [7, 4], [6, 5]])
|
||||
|
||||
CODET1 = np.array([[3.0000, 3.0000],
|
||||
[6.2000, 4.0000],
|
||||
[5.8000, 1.8000]])
|
||||
|
||||
CODET2 = np.array([[11.0/3, 8.0/3],
|
||||
[6.7500, 4.2500],
|
||||
[6.2500, 1.7500]])
|
||||
|
||||
LABEL1 = np.array([0, 1, 2, 2, 2, 2, 1, 2, 1, 1, 1])
|
||||
|
||||
|
||||
class TestWhiten:
|
||||
def test_whiten(self):
|
||||
desired = np.array([[5.08738849, 2.97091878],
|
||||
[3.19909255, 0.69660580],
|
||||
[4.51041982, 0.02640918],
|
||||
[4.38567074, 0.95120889],
|
||||
[2.32191480, 1.63195503]])
|
||||
for tp in np.array, matrix:
|
||||
obs = tp([[0.98744510, 0.82766775],
|
||||
[0.62093317, 0.19406729],
|
||||
[0.87545741, 0.00735733],
|
||||
[0.85124403, 0.26499712],
|
||||
[0.45067590, 0.45464607]])
|
||||
assert_allclose(whiten(obs), desired, rtol=1e-5)
|
||||
|
||||
def test_whiten_zero_std(self):
|
||||
desired = np.array([[0., 1.0, 2.86666544],
|
||||
[0., 1.0, 1.32460034],
|
||||
[0., 1.0, 3.74382172]])
|
||||
for tp in np.array, matrix:
|
||||
obs = tp([[0., 1., 0.74109533],
|
||||
[0., 1., 0.34243798],
|
||||
[0., 1., 0.96785929]])
|
||||
with warnings.catch_warnings(record=True) as w:
|
||||
warnings.simplefilter('always')
|
||||
assert_allclose(whiten(obs), desired, rtol=1e-5)
|
||||
assert_equal(len(w), 1)
|
||||
assert_(issubclass(w[-1].category, RuntimeWarning))
|
||||
|
||||
def test_whiten_not_finite(self):
|
||||
for tp in np.array, matrix:
|
||||
for bad_value in np.nan, np.inf, -np.inf:
|
||||
obs = tp([[0.98744510, bad_value],
|
||||
[0.62093317, 0.19406729],
|
||||
[0.87545741, 0.00735733],
|
||||
[0.85124403, 0.26499712],
|
||||
[0.45067590, 0.45464607]])
|
||||
assert_raises(ValueError, whiten, obs)
|
||||
|
||||
|
||||
class TestVq:
|
||||
def test_py_vq(self):
|
||||
initc = np.concatenate(([[X[0]], [X[1]], [X[2]]]))
|
||||
for tp in np.array, matrix:
|
||||
label1 = py_vq(tp(X), tp(initc))[0]
|
||||
assert_array_equal(label1, LABEL1)
|
||||
|
||||
def test_vq(self):
|
||||
initc = np.concatenate(([[X[0]], [X[1]], [X[2]]]))
|
||||
for tp in np.array, matrix:
|
||||
label1, dist = _vq.vq(tp(X), tp(initc))
|
||||
assert_array_equal(label1, LABEL1)
|
||||
tlabel1, tdist = vq(tp(X), tp(initc))
|
||||
|
||||
def test_vq_1d(self):
|
||||
# Test special rank 1 vq algo, python implementation.
|
||||
data = X[:, 0]
|
||||
initc = data[:3]
|
||||
a, b = _vq.vq(data, initc)
|
||||
ta, tb = py_vq(data[:, np.newaxis], initc[:, np.newaxis])
|
||||
assert_array_equal(a, ta)
|
||||
assert_array_equal(b, tb)
|
||||
|
||||
def test__vq_sametype(self):
|
||||
a = np.array([1.0, 2.0], dtype=np.float64)
|
||||
b = a.astype(np.float32)
|
||||
assert_raises(TypeError, _vq.vq, a, b)
|
||||
|
||||
def test__vq_invalid_type(self):
|
||||
a = np.array([1, 2], dtype=int)
|
||||
assert_raises(TypeError, _vq.vq, a, a)
|
||||
|
||||
def test_vq_large_nfeat(self):
|
||||
X = np.random.rand(20, 20)
|
||||
code_book = np.random.rand(3, 20)
|
||||
|
||||
codes0, dis0 = _vq.vq(X, code_book)
|
||||
codes1, dis1 = py_vq(X, code_book)
|
||||
assert_allclose(dis0, dis1, 1e-5)
|
||||
assert_array_equal(codes0, codes1)
|
||||
|
||||
X = X.astype(np.float32)
|
||||
code_book = code_book.astype(np.float32)
|
||||
|
||||
codes0, dis0 = _vq.vq(X, code_book)
|
||||
codes1, dis1 = py_vq(X, code_book)
|
||||
assert_allclose(dis0, dis1, 1e-5)
|
||||
assert_array_equal(codes0, codes1)
|
||||
|
||||
def test_vq_large_features(self):
|
||||
X = np.random.rand(10, 5) * 1000000
|
||||
code_book = np.random.rand(2, 5) * 1000000
|
||||
|
||||
codes0, dis0 = _vq.vq(X, code_book)
|
||||
codes1, dis1 = py_vq(X, code_book)
|
||||
assert_allclose(dis0, dis1, 1e-5)
|
||||
assert_array_equal(codes0, codes1)
|
||||
|
||||
|
||||
class TestKMean:
|
||||
def test_large_features(self):
|
||||
# Generate a data set with large values, and run kmeans on it to
|
||||
# (regression for 1077).
|
||||
d = 300
|
||||
n = 100
|
||||
|
||||
m1 = np.random.randn(d)
|
||||
m2 = np.random.randn(d)
|
||||
x = 10000 * np.random.randn(n, d) - 20000 * m1
|
||||
y = 10000 * np.random.randn(n, d) + 20000 * m2
|
||||
|
||||
data = np.empty((x.shape[0] + y.shape[0], d), np.double)
|
||||
data[:x.shape[0]] = x
|
||||
data[x.shape[0]:] = y
|
||||
|
||||
kmeans(data, 2)
|
||||
|
||||
def test_kmeans_simple(self):
|
||||
np.random.seed(54321)
|
||||
initc = np.concatenate(([[X[0]], [X[1]], [X[2]]]))
|
||||
for tp in np.array, matrix:
|
||||
code1 = kmeans(tp(X), tp(initc), iter=1)[0]
|
||||
assert_array_almost_equal(code1, CODET2)
|
||||
|
||||
def test_kmeans_lost_cluster(self):
|
||||
# This will cause kmeans to have a cluster with no points.
|
||||
data = TESTDATA_2D
|
||||
initk = np.array([[-1.8127404, -0.67128041],
|
||||
[2.04621601, 0.07401111],
|
||||
[-2.31149087, -0.05160469]])
|
||||
|
||||
kmeans(data, initk)
|
||||
with suppress_warnings() as sup:
|
||||
sup.filter(UserWarning,
|
||||
"One of the clusters is empty. Re-run kmeans with a "
|
||||
"different initialization")
|
||||
kmeans2(data, initk, missing='warn')
|
||||
|
||||
assert_raises(ClusterError, kmeans2, data, initk, missing='raise')
|
||||
|
||||
def test_kmeans2_simple(self):
|
||||
np.random.seed(12345678)
|
||||
initc = np.concatenate(([[X[0]], [X[1]], [X[2]]]))
|
||||
for tp in np.array, matrix:
|
||||
code1 = kmeans2(tp(X), tp(initc), iter=1)[0]
|
||||
code2 = kmeans2(tp(X), tp(initc), iter=2)[0]
|
||||
|
||||
assert_array_almost_equal(code1, CODET1)
|
||||
assert_array_almost_equal(code2, CODET2)
|
||||
|
||||
def test_kmeans2_rank1(self):
|
||||
data = TESTDATA_2D
|
||||
data1 = data[:, 0]
|
||||
|
||||
initc = data1[:3]
|
||||
code = initc.copy()
|
||||
kmeans2(data1, code, iter=1)[0]
|
||||
kmeans2(data1, code, iter=2)[0]
|
||||
|
||||
def test_kmeans2_rank1_2(self):
|
||||
data = TESTDATA_2D
|
||||
data1 = data[:, 0]
|
||||
kmeans2(data1, 2, iter=1)
|
||||
|
||||
def test_kmeans2_high_dim(self):
|
||||
# test kmeans2 when the number of dimensions exceeds the number
|
||||
# of input points
|
||||
data = TESTDATA_2D
|
||||
data = data.reshape((20, 20))[:10]
|
||||
kmeans2(data, 2)
|
||||
|
||||
def test_kmeans2_init(self):
|
||||
np.random.seed(12345)
|
||||
data = TESTDATA_2D
|
||||
|
||||
kmeans2(data, 3, minit='points')
|
||||
kmeans2(data[:, :1], 3, minit='points') # special case (1-D)
|
||||
|
||||
kmeans2(data, 3, minit='++')
|
||||
kmeans2(data[:, :1], 3, minit='++') # special case (1-D)
|
||||
|
||||
# minit='random' can give warnings, filter those
|
||||
with suppress_warnings() as sup:
|
||||
sup.filter(message="One of the clusters is empty. Re-run.")
|
||||
kmeans2(data, 3, minit='random')
|
||||
kmeans2(data[:, :1], 3, minit='random') # special case (1-D)
|
||||
|
||||
@pytest.mark.skipif(sys.platform == 'win32',
|
||||
reason='Fails with MemoryError in Wine.')
|
||||
def test_krandinit(self):
|
||||
data = TESTDATA_2D
|
||||
datas = [data.reshape((200, 2)), data.reshape((20, 20))[:10]]
|
||||
k = int(1e6)
|
||||
for data in datas:
|
||||
# check that np.random.Generator can be used (numpy >= 1.17)
|
||||
if hasattr(np.random, 'default_rng'):
|
||||
rng = np.random.default_rng(1234)
|
||||
else:
|
||||
rng = np.random.RandomState(1234)
|
||||
|
||||
init = _krandinit(data, k, rng)
|
||||
orig_cov = np.cov(data, rowvar=0)
|
||||
init_cov = np.cov(init, rowvar=0)
|
||||
assert_allclose(orig_cov, init_cov, atol=1e-2)
|
||||
|
||||
def test_kmeans2_empty(self):
|
||||
# Regression test for gh-1032.
|
||||
assert_raises(ValueError, kmeans2, [], 2)
|
||||
|
||||
def test_kmeans_0k(self):
|
||||
# Regression test for gh-1073: fail when k arg is 0.
|
||||
assert_raises(ValueError, kmeans, X, 0)
|
||||
assert_raises(ValueError, kmeans2, X, 0)
|
||||
assert_raises(ValueError, kmeans2, X, np.array([]))
|
||||
|
||||
def test_kmeans_large_thres(self):
|
||||
# Regression test for gh-1774
|
||||
x = np.array([1, 2, 3, 4, 10], dtype=float)
|
||||
res = kmeans(x, 1, thresh=1e16)
|
||||
assert_allclose(res[0], np.array([4.]))
|
||||
assert_allclose(res[1], 2.3999999999999999)
|
||||
|
||||
def test_kmeans2_kpp_low_dim(self):
|
||||
# Regression test for gh-11462
|
||||
prev_res = np.array([[-1.95266667, 0.898],
|
||||
[-3.153375, 3.3945]])
|
||||
np.random.seed(42)
|
||||
res, _ = kmeans2(TESTDATA_2D, 2, minit='++')
|
||||
assert_allclose(res, prev_res)
|
||||
|
||||
def test_kmeans2_kpp_high_dim(self):
|
||||
# Regression test for gh-11462
|
||||
n_dim = 100
|
||||
size = 10
|
||||
centers = np.vstack([5 * np.ones(n_dim),
|
||||
-5 * np.ones(n_dim)])
|
||||
np.random.seed(42)
|
||||
data = np.vstack([
|
||||
np.random.multivariate_normal(centers[0], np.eye(n_dim), size=size),
|
||||
np.random.multivariate_normal(centers[1], np.eye(n_dim), size=size)
|
||||
])
|
||||
res, _ = kmeans2(data, 2, minit='++')
|
||||
assert_array_almost_equal(res, centers, decimal=0)
|
||||
|
||||
def test_kmeans_and_kmeans2_random_seed(self):
|
||||
|
||||
seed_list = [1234, np.random.RandomState(1234)]
|
||||
|
||||
# check that np.random.Generator can be used (numpy >= 1.17)
|
||||
if hasattr(np.random, 'default_rng'):
|
||||
seed_list.append(np.random.default_rng(1234))
|
||||
|
||||
for seed in seed_list:
|
||||
# test for kmeans
|
||||
res1, _ = kmeans(TESTDATA_2D, 2, seed=seed)
|
||||
res2, _ = kmeans(TESTDATA_2D, 2, seed=seed)
|
||||
assert_allclose(res1, res1) # should be same results
|
||||
|
||||
# test for kmeans2
|
||||
for minit in ["random", "points", "++"]:
|
||||
res1, _ = kmeans2(TESTDATA_2D, 2, minit=minit, seed=seed)
|
||||
res2, _ = kmeans2(TESTDATA_2D, 2, minit=minit, seed=seed)
|
||||
assert_allclose(res1, res1) # should be same results
|
||||
Vendored
-801
@@ -1,801 +0,0 @@
|
||||
"""
|
||||
K-means clustering and vector quantization (:mod:`scipy.cluster.vq`)
|
||||
====================================================================
|
||||
|
||||
Provides routines for k-means clustering, generating code books
|
||||
from k-means models and quantizing vectors by comparing them with
|
||||
centroids in a code book.
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
whiten -- Normalize a group of observations so each feature has unit variance
|
||||
vq -- Calculate code book membership of a set of observation vectors
|
||||
kmeans -- Perform k-means on a set of observation vectors forming k clusters
|
||||
kmeans2 -- A different implementation of k-means with more methods
|
||||
-- for initializing centroids
|
||||
|
||||
Background information
|
||||
----------------------
|
||||
The k-means algorithm takes as input the number of clusters to
|
||||
generate, k, and a set of observation vectors to cluster. It
|
||||
returns a set of centroids, one for each of the k clusters. An
|
||||
observation vector is classified with the cluster number or
|
||||
centroid index of the centroid closest to it.
|
||||
|
||||
A vector v belongs to cluster i if it is closer to centroid i than
|
||||
any other centroid. If v belongs to i, we say centroid i is the
|
||||
dominating centroid of v. The k-means algorithm tries to
|
||||
minimize distortion, which is defined as the sum of the squared distances
|
||||
between each observation vector and its dominating centroid.
|
||||
The minimization is achieved by iteratively reclassifying
|
||||
the observations into clusters and recalculating the centroids until
|
||||
a configuration is reached in which the centroids are stable. One can
|
||||
also define a maximum number of iterations.
|
||||
|
||||
Since vector quantization is a natural application for k-means,
|
||||
information theory terminology is often used. The centroid index
|
||||
or cluster index is also referred to as a "code" and the table
|
||||
mapping codes to centroids and, vice versa, is often referred to as a
|
||||
"code book". The result of k-means, a set of centroids, can be
|
||||
used to quantize vectors. Quantization aims to find an encoding of
|
||||
vectors that reduces the expected distortion.
|
||||
|
||||
All routines expect obs to be an M by N array, where the rows are
|
||||
the observation vectors. The codebook is a k by N array, where the
|
||||
ith row is the centroid of code word i. The observation vectors
|
||||
and centroids have the same feature dimension.
|
||||
|
||||
As an example, suppose we wish to compress a 24-bit color image
|
||||
(each pixel is represented by one byte for red, one for blue, and
|
||||
one for green) before sending it over the web. By using a smaller
|
||||
8-bit encoding, we can reduce the amount of data by two
|
||||
thirds. Ideally, the colors for each of the 256 possible 8-bit
|
||||
encoding values should be chosen to minimize distortion of the
|
||||
color. Running k-means with k=256 generates a code book of 256
|
||||
codes, which fills up all possible 8-bit sequences. Instead of
|
||||
sending a 3-byte value for each pixel, the 8-bit centroid index
|
||||
(or code word) of the dominating centroid is transmitted. The code
|
||||
book is also sent over the wire so each 8-bit code can be
|
||||
translated back to a 24-bit pixel value representation. If the
|
||||
image of interest was of an ocean, we would expect many 24-bit
|
||||
blues to be represented by 8-bit codes. If it was an image of a
|
||||
human face, more flesh-tone colors would be represented in the
|
||||
code book.
|
||||
|
||||
"""
|
||||
import warnings
|
||||
import numpy as np
|
||||
from collections import deque
|
||||
from scipy._lib._util import _asarray_validated, check_random_state,\
|
||||
rng_integers
|
||||
from scipy.spatial.distance import cdist
|
||||
|
||||
from . import _vq
|
||||
|
||||
__docformat__ = 'restructuredtext'
|
||||
|
||||
__all__ = ['whiten', 'vq', 'kmeans', 'kmeans2']
|
||||
|
||||
|
||||
class ClusterError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
def whiten(obs, check_finite=True):
|
||||
"""
|
||||
Normalize a group of observations on a per feature basis.
|
||||
|
||||
Before running k-means, it is beneficial to rescale each feature
|
||||
dimension of the observation set by its standard deviation (i.e. "whiten"
|
||||
it - as in "white noise" where each frequency has equal power).
|
||||
Each feature is divided by its standard deviation across all observations
|
||||
to give it unit variance.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
obs : ndarray
|
||||
Each row of the array is an observation. The
|
||||
columns are the features seen during each observation.
|
||||
|
||||
>>> # f0 f1 f2
|
||||
>>> obs = [[ 1., 1., 1.], #o0
|
||||
... [ 2., 2., 2.], #o1
|
||||
... [ 3., 3., 3.], #o2
|
||||
... [ 4., 4., 4.]] #o3
|
||||
|
||||
check_finite : bool, optional
|
||||
Whether to check that the input matrices contain only finite numbers.
|
||||
Disabling may give a performance gain, but may result in problems
|
||||
(crashes, non-termination) if the inputs do contain infinities or NaNs.
|
||||
Default: True
|
||||
|
||||
Returns
|
||||
-------
|
||||
result : ndarray
|
||||
Contains the values in `obs` scaled by the standard deviation
|
||||
of each column.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy.cluster.vq import whiten
|
||||
>>> features = np.array([[1.9, 2.3, 1.7],
|
||||
... [1.5, 2.5, 2.2],
|
||||
... [0.8, 0.6, 1.7,]])
|
||||
>>> whiten(features)
|
||||
array([[ 4.17944278, 2.69811351, 7.21248917],
|
||||
[ 3.29956009, 2.93273208, 9.33380951],
|
||||
[ 1.75976538, 0.7038557 , 7.21248917]])
|
||||
|
||||
"""
|
||||
obs = _asarray_validated(obs, check_finite=check_finite)
|
||||
std_dev = obs.std(axis=0)
|
||||
zero_std_mask = std_dev == 0
|
||||
if zero_std_mask.any():
|
||||
std_dev[zero_std_mask] = 1.0
|
||||
warnings.warn("Some columns have standard deviation zero. "
|
||||
"The values of these columns will not change.",
|
||||
RuntimeWarning)
|
||||
return obs / std_dev
|
||||
|
||||
|
||||
def vq(obs, code_book, check_finite=True):
|
||||
"""
|
||||
Assign codes from a code book to observations.
|
||||
|
||||
Assigns a code from a code book to each observation. Each
|
||||
observation vector in the 'M' by 'N' `obs` array is compared with the
|
||||
centroids in the code book and assigned the code of the closest
|
||||
centroid.
|
||||
|
||||
The features in `obs` should have unit variance, which can be
|
||||
achieved by passing them through the whiten function. The code
|
||||
book can be created with the k-means algorithm or a different
|
||||
encoding algorithm.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
obs : ndarray
|
||||
Each row of the 'M' x 'N' array is an observation. The columns are
|
||||
the "features" seen during each observation. The features must be
|
||||
whitened first using the whiten function or something equivalent.
|
||||
code_book : ndarray
|
||||
The code book is usually generated using the k-means algorithm.
|
||||
Each row of the array holds a different code, and the columns are
|
||||
the features of the code.
|
||||
|
||||
>>> # f0 f1 f2 f3
|
||||
>>> code_book = [
|
||||
... [ 1., 2., 3., 4.], #c0
|
||||
... [ 1., 2., 3., 4.], #c1
|
||||
... [ 1., 2., 3., 4.]] #c2
|
||||
|
||||
check_finite : bool, optional
|
||||
Whether to check that the input matrices contain only finite numbers.
|
||||
Disabling may give a performance gain, but may result in problems
|
||||
(crashes, non-termination) if the inputs do contain infinities or NaNs.
|
||||
Default: True
|
||||
|
||||
Returns
|
||||
-------
|
||||
code : ndarray
|
||||
A length M array holding the code book index for each observation.
|
||||
dist : ndarray
|
||||
The distortion (distance) between the observation and its nearest
|
||||
code.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from numpy import array
|
||||
>>> from scipy.cluster.vq import vq
|
||||
>>> code_book = array([[1.,1.,1.],
|
||||
... [2.,2.,2.]])
|
||||
>>> features = array([[ 1.9,2.3,1.7],
|
||||
... [ 1.5,2.5,2.2],
|
||||
... [ 0.8,0.6,1.7]])
|
||||
>>> vq(features,code_book)
|
||||
(array([1, 1, 0],'i'), array([ 0.43588989, 0.73484692, 0.83066239]))
|
||||
|
||||
"""
|
||||
obs = _asarray_validated(obs, check_finite=check_finite)
|
||||
code_book = _asarray_validated(code_book, check_finite=check_finite)
|
||||
ct = np.common_type(obs, code_book)
|
||||
|
||||
c_obs = obs.astype(ct, copy=False)
|
||||
c_code_book = code_book.astype(ct, copy=False)
|
||||
|
||||
if np.issubdtype(ct, np.float64) or np.issubdtype(ct, np.float32):
|
||||
return _vq.vq(c_obs, c_code_book)
|
||||
return py_vq(obs, code_book, check_finite=False)
|
||||
|
||||
|
||||
def py_vq(obs, code_book, check_finite=True):
|
||||
""" Python version of vq algorithm.
|
||||
|
||||
The algorithm computes the Euclidean distance between each
|
||||
observation and every frame in the code_book.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
obs : ndarray
|
||||
Expects a rank 2 array. Each row is one observation.
|
||||
code_book : ndarray
|
||||
Code book to use. Same format than obs. Should have same number of
|
||||
features (e.g., columns) than obs.
|
||||
check_finite : bool, optional
|
||||
Whether to check that the input matrices contain only finite numbers.
|
||||
Disabling may give a performance gain, but may result in problems
|
||||
(crashes, non-termination) if the inputs do contain infinities or NaNs.
|
||||
Default: True
|
||||
|
||||
Returns
|
||||
-------
|
||||
code : ndarray
|
||||
code[i] gives the label of the ith obversation; its code is
|
||||
code_book[code[i]].
|
||||
mind_dist : ndarray
|
||||
min_dist[i] gives the distance between the ith observation and its
|
||||
corresponding code.
|
||||
|
||||
Notes
|
||||
-----
|
||||
This function is slower than the C version but works for
|
||||
all input types. If the inputs have the wrong types for the
|
||||
C versions of the function, this one is called as a last resort.
|
||||
|
||||
It is about 20 times slower than the C version.
|
||||
|
||||
"""
|
||||
obs = _asarray_validated(obs, check_finite=check_finite)
|
||||
code_book = _asarray_validated(code_book, check_finite=check_finite)
|
||||
|
||||
if obs.ndim != code_book.ndim:
|
||||
raise ValueError("Observation and code_book should have the same rank")
|
||||
|
||||
if obs.ndim == 1:
|
||||
obs = obs[:, np.newaxis]
|
||||
code_book = code_book[:, np.newaxis]
|
||||
|
||||
dist = cdist(obs, code_book)
|
||||
code = dist.argmin(axis=1)
|
||||
min_dist = dist[np.arange(len(code)), code]
|
||||
return code, min_dist
|
||||
|
||||
|
||||
# py_vq2 was equivalent to py_vq
|
||||
py_vq2 = np.deprecate(py_vq, old_name='py_vq2', new_name='py_vq')
|
||||
|
||||
|
||||
def _kmeans(obs, guess, thresh=1e-5):
|
||||
""" "raw" version of k-means.
|
||||
|
||||
Returns
|
||||
-------
|
||||
code_book
|
||||
The lowest distortion codebook found.
|
||||
avg_dist
|
||||
The average distance a observation is from a code in the book.
|
||||
Lower means the code_book matches the data better.
|
||||
|
||||
See Also
|
||||
--------
|
||||
kmeans : wrapper around k-means
|
||||
|
||||
Examples
|
||||
--------
|
||||
Note: not whitened in this example.
|
||||
|
||||
>>> from numpy import array
|
||||
>>> from scipy.cluster.vq import _kmeans
|
||||
>>> features = array([[ 1.9,2.3],
|
||||
... [ 1.5,2.5],
|
||||
... [ 0.8,0.6],
|
||||
... [ 0.4,1.8],
|
||||
... [ 1.0,1.0]])
|
||||
>>> book = array((features[0],features[2]))
|
||||
>>> _kmeans(features,book)
|
||||
(array([[ 1.7 , 2.4 ],
|
||||
[ 0.73333333, 1.13333333]]), 0.40563916697728591)
|
||||
|
||||
"""
|
||||
|
||||
code_book = np.asarray(guess)
|
||||
diff = np.inf
|
||||
prev_avg_dists = deque([diff], maxlen=2)
|
||||
while diff > thresh:
|
||||
# compute membership and distances between obs and code_book
|
||||
obs_code, distort = vq(obs, code_book, check_finite=False)
|
||||
prev_avg_dists.append(distort.mean(axis=-1))
|
||||
# recalc code_book as centroids of associated obs
|
||||
code_book, has_members = _vq.update_cluster_means(obs, obs_code,
|
||||
code_book.shape[0])
|
||||
code_book = code_book[has_members]
|
||||
diff = prev_avg_dists[0] - prev_avg_dists[1]
|
||||
|
||||
return code_book, prev_avg_dists[1]
|
||||
|
||||
|
||||
def kmeans(obs, k_or_guess, iter=20, thresh=1e-5, check_finite=True,
|
||||
*, seed=None):
|
||||
"""
|
||||
Performs k-means on a set of observation vectors forming k clusters.
|
||||
|
||||
The k-means algorithm adjusts the classification of the observations
|
||||
into clusters and updates the cluster centroids until the position of
|
||||
the centroids is stable over successive iterations. In this
|
||||
implementation of the algorithm, the stability of the centroids is
|
||||
determined by comparing the absolute value of the change in the average
|
||||
Euclidean distance between the observations and their corresponding
|
||||
centroids against a threshold. This yields
|
||||
a code book mapping centroids to codes and vice versa.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
obs : ndarray
|
||||
Each row of the M by N array is an observation vector. The
|
||||
columns are the features seen during each observation.
|
||||
The features must be whitened first with the `whiten` function.
|
||||
|
||||
k_or_guess : int or ndarray
|
||||
The number of centroids to generate. A code is assigned to
|
||||
each centroid, which is also the row index of the centroid
|
||||
in the code_book matrix generated.
|
||||
|
||||
The initial k centroids are chosen by randomly selecting
|
||||
observations from the observation matrix. Alternatively,
|
||||
passing a k by N array specifies the initial k centroids.
|
||||
|
||||
iter : int, optional
|
||||
The number of times to run k-means, returning the codebook
|
||||
with the lowest distortion. This argument is ignored if
|
||||
initial centroids are specified with an array for the
|
||||
``k_or_guess`` parameter. This parameter does not represent the
|
||||
number of iterations of the k-means algorithm.
|
||||
|
||||
thresh : float, optional
|
||||
Terminates the k-means algorithm if the change in
|
||||
distortion since the last k-means iteration is less than
|
||||
or equal to threshold.
|
||||
|
||||
check_finite : bool, optional
|
||||
Whether to check that the input matrices contain only finite numbers.
|
||||
Disabling may give a performance gain, but may result in problems
|
||||
(crashes, non-termination) if the inputs do contain infinities or NaNs.
|
||||
Default: True
|
||||
|
||||
seed : {None, int, `numpy.random.Generator`,
|
||||
`numpy.random.RandomState`}, optional
|
||||
|
||||
Seed for initializing the pseudo-random number generator.
|
||||
If `seed` is None (or `numpy.random`), the `numpy.random.RandomState`
|
||||
singleton is used.
|
||||
If `seed` is an int, a new ``RandomState`` instance is used,
|
||||
seeded with `seed`.
|
||||
If `seed` is already a ``Generator`` or ``RandomState`` instance then
|
||||
that instance is used.
|
||||
The default is None.
|
||||
|
||||
Returns
|
||||
-------
|
||||
codebook : ndarray
|
||||
A k by N array of k centroids. The ith centroid
|
||||
codebook[i] is represented with the code i. The centroids
|
||||
and codes generated represent the lowest distortion seen,
|
||||
not necessarily the globally minimal distortion.
|
||||
Note that the number of centroids is not necessarily the same as the
|
||||
``k_or_guess`` parameter, because centroids assigned to no observations
|
||||
are removed during iterations.
|
||||
|
||||
distortion : float
|
||||
The mean (non-squared) Euclidean distance between the observations
|
||||
passed and the centroids generated. Note the difference to the standard
|
||||
definition of distortion in the context of the k-means algorithm, which
|
||||
is the sum of the squared distances.
|
||||
|
||||
See Also
|
||||
--------
|
||||
kmeans2 : a different implementation of k-means clustering
|
||||
with more methods for generating initial centroids but without
|
||||
using a distortion change threshold as a stopping criterion.
|
||||
|
||||
whiten : must be called prior to passing an observation matrix
|
||||
to kmeans.
|
||||
|
||||
Notes
|
||||
-----
|
||||
For more functionalities or optimal performance, you can use
|
||||
`sklearn.cluster.KMeans <https://scikit-learn.org/stable/modules/generated/sklearn.cluster.KMeans.html>`_.
|
||||
`This <https://hdbscan.readthedocs.io/en/latest/performance_and_scalability.html#comparison-of-high-performance-implementations>`_
|
||||
is a benchmark result of several implementations.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from numpy import array
|
||||
>>> from scipy.cluster.vq import vq, kmeans, whiten
|
||||
>>> import matplotlib.pyplot as plt
|
||||
>>> features = array([[ 1.9,2.3],
|
||||
... [ 1.5,2.5],
|
||||
... [ 0.8,0.6],
|
||||
... [ 0.4,1.8],
|
||||
... [ 0.1,0.1],
|
||||
... [ 0.2,1.8],
|
||||
... [ 2.0,0.5],
|
||||
... [ 0.3,1.5],
|
||||
... [ 1.0,1.0]])
|
||||
>>> whitened = whiten(features)
|
||||
>>> book = np.array((whitened[0],whitened[2]))
|
||||
>>> kmeans(whitened,book)
|
||||
(array([[ 2.3110306 , 2.86287398], # random
|
||||
[ 0.93218041, 1.24398691]]), 0.85684700941625547)
|
||||
|
||||
>>> codes = 3
|
||||
>>> kmeans(whitened,codes)
|
||||
(array([[ 2.3110306 , 2.86287398], # random
|
||||
[ 1.32544402, 0.65607529],
|
||||
[ 0.40782893, 2.02786907]]), 0.5196582527686241)
|
||||
|
||||
>>> # Create 50 datapoints in two clusters a and b
|
||||
>>> pts = 50
|
||||
>>> rng = np.random.default_rng()
|
||||
>>> a = rng.multivariate_normal([0, 0], [[4, 1], [1, 4]], size=pts)
|
||||
>>> b = rng.multivariate_normal([30, 10],
|
||||
... [[10, 2], [2, 1]],
|
||||
... size=pts)
|
||||
>>> features = np.concatenate((a, b))
|
||||
>>> # Whiten data
|
||||
>>> whitened = whiten(features)
|
||||
>>> # Find 2 clusters in the data
|
||||
>>> codebook, distortion = kmeans(whitened, 2)
|
||||
>>> # Plot whitened data and cluster centers in red
|
||||
>>> plt.scatter(whitened[:, 0], whitened[:, 1])
|
||||
>>> plt.scatter(codebook[:, 0], codebook[:, 1], c='r')
|
||||
>>> plt.show()
|
||||
|
||||
"""
|
||||
obs = _asarray_validated(obs, check_finite=check_finite)
|
||||
if iter < 1:
|
||||
raise ValueError("iter must be at least 1, got %s" % iter)
|
||||
|
||||
# Determine whether a count (scalar) or an initial guess (array) was passed.
|
||||
if not np.isscalar(k_or_guess):
|
||||
guess = _asarray_validated(k_or_guess, check_finite=check_finite)
|
||||
if guess.size < 1:
|
||||
raise ValueError("Asked for 0 clusters. Initial book was %s" %
|
||||
guess)
|
||||
return _kmeans(obs, guess, thresh=thresh)
|
||||
|
||||
# k_or_guess is a scalar, now verify that it's an integer
|
||||
k = int(k_or_guess)
|
||||
if k != k_or_guess:
|
||||
raise ValueError("If k_or_guess is a scalar, it must be an integer.")
|
||||
if k < 1:
|
||||
raise ValueError("Asked for %d clusters." % k)
|
||||
|
||||
rng = check_random_state(seed)
|
||||
|
||||
# initialize best distance value to a large value
|
||||
best_dist = np.inf
|
||||
for i in range(iter):
|
||||
# the initial code book is randomly selected from observations
|
||||
guess = _kpoints(obs, k, rng)
|
||||
book, dist = _kmeans(obs, guess, thresh=thresh)
|
||||
if dist < best_dist:
|
||||
best_book = book
|
||||
best_dist = dist
|
||||
return best_book, best_dist
|
||||
|
||||
|
||||
def _kpoints(data, k, rng):
|
||||
"""Pick k points at random in data (one row = one observation).
|
||||
|
||||
Parameters
|
||||
----------
|
||||
data : ndarray
|
||||
Expect a rank 1 or 2 array. Rank 1 are assumed to describe one
|
||||
dimensional data, rank 2 multidimensional data, in which case one
|
||||
row is one observation.
|
||||
k : int
|
||||
Number of samples to generate.
|
||||
rng : `numpy.random.Generator` or `numpy.random.RandomState`
|
||||
Random number generator.
|
||||
|
||||
Returns
|
||||
-------
|
||||
x : ndarray
|
||||
A 'k' by 'N' containing the initial centroids
|
||||
|
||||
"""
|
||||
idx = rng.choice(data.shape[0], size=k, replace=False)
|
||||
return data[idx]
|
||||
|
||||
|
||||
def _krandinit(data, k, rng):
|
||||
"""Returns k samples of a random variable whose parameters depend on data.
|
||||
|
||||
More precisely, it returns k observations sampled from a Gaussian random
|
||||
variable whose mean and covariances are the ones estimated from the data.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
data : ndarray
|
||||
Expect a rank 1 or 2 array. Rank 1 is assumed to describe 1-D
|
||||
data, rank 2 multidimensional data, in which case one
|
||||
row is one observation.
|
||||
k : int
|
||||
Number of samples to generate.
|
||||
rng : `numpy.random.Generator` or `numpy.random.RandomState`
|
||||
Random number generator.
|
||||
|
||||
Returns
|
||||
-------
|
||||
x : ndarray
|
||||
A 'k' by 'N' containing the initial centroids
|
||||
|
||||
"""
|
||||
mu = data.mean(axis=0)
|
||||
|
||||
if data.ndim == 1:
|
||||
cov = np.cov(data)
|
||||
x = rng.standard_normal(size=k)
|
||||
x *= np.sqrt(cov)
|
||||
elif data.shape[1] > data.shape[0]:
|
||||
# initialize when the covariance matrix is rank deficient
|
||||
_, s, vh = np.linalg.svd(data - mu, full_matrices=False)
|
||||
x = rng.standard_normal(size=(k, s.size))
|
||||
sVh = s[:, None] * vh / np.sqrt(data.shape[0] - 1)
|
||||
x = x.dot(sVh)
|
||||
else:
|
||||
cov = np.atleast_2d(np.cov(data, rowvar=False))
|
||||
|
||||
# k rows, d cols (one row = one obs)
|
||||
# Generate k sample of a random variable ~ Gaussian(mu, cov)
|
||||
x = rng.standard_normal(size=(k, mu.size))
|
||||
x = x.dot(np.linalg.cholesky(cov).T)
|
||||
|
||||
x += mu
|
||||
return x
|
||||
|
||||
|
||||
def _kpp(data, k, rng):
|
||||
""" Picks k points in the data based on the kmeans++ method.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
data : ndarray
|
||||
Expect a rank 1 or 2 array. Rank 1 is assumed to describe 1-D
|
||||
data, rank 2 multidimensional data, in which case one
|
||||
row is one observation.
|
||||
k : int
|
||||
Number of samples to generate.
|
||||
rng : `numpy.random.Generator` or `numpy.random.RandomState`
|
||||
Random number generator.
|
||||
|
||||
Returns
|
||||
-------
|
||||
init : ndarray
|
||||
A 'k' by 'N' containing the initial centroids.
|
||||
|
||||
References
|
||||
----------
|
||||
.. [1] D. Arthur and S. Vassilvitskii, "k-means++: the advantages of
|
||||
careful seeding", Proceedings of the Eighteenth Annual ACM-SIAM Symposium
|
||||
on Discrete Algorithms, 2007.
|
||||
"""
|
||||
|
||||
dims = data.shape[1] if len(data.shape) > 1 else 1
|
||||
init = np.ndarray((k, dims))
|
||||
|
||||
for i in range(k):
|
||||
if i == 0:
|
||||
init[i, :] = data[rng_integers(rng, data.shape[0])]
|
||||
|
||||
else:
|
||||
D2 = cdist(init[:i,:], data, metric='sqeuclidean').min(axis=0)
|
||||
probs = D2/D2.sum()
|
||||
cumprobs = probs.cumsum()
|
||||
r = rng.uniform()
|
||||
init[i, :] = data[np.searchsorted(cumprobs, r)]
|
||||
|
||||
return init
|
||||
|
||||
|
||||
_valid_init_meth = {'random': _krandinit, 'points': _kpoints, '++': _kpp}
|
||||
|
||||
|
||||
def _missing_warn():
|
||||
"""Print a warning when called."""
|
||||
warnings.warn("One of the clusters is empty. "
|
||||
"Re-run kmeans with a different initialization.")
|
||||
|
||||
|
||||
def _missing_raise():
|
||||
"""Raise a ClusterError when called."""
|
||||
raise ClusterError("One of the clusters is empty. "
|
||||
"Re-run kmeans with a different initialization.")
|
||||
|
||||
|
||||
_valid_miss_meth = {'warn': _missing_warn, 'raise': _missing_raise}
|
||||
|
||||
|
||||
def kmeans2(data, k, iter=10, thresh=1e-5, minit='random',
|
||||
missing='warn', check_finite=True, *, seed=None):
|
||||
"""
|
||||
Classify a set of observations into k clusters using the k-means algorithm.
|
||||
|
||||
The algorithm attempts to minimize the Euclidean distance between
|
||||
observations and centroids. Several initialization methods are
|
||||
included.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
data : ndarray
|
||||
A 'M' by 'N' array of 'M' observations in 'N' dimensions or a length
|
||||
'M' array of 'M' 1-D observations.
|
||||
k : int or ndarray
|
||||
The number of clusters to form as well as the number of
|
||||
centroids to generate. If `minit` initialization string is
|
||||
'matrix', or if a ndarray is given instead, it is
|
||||
interpreted as initial cluster to use instead.
|
||||
iter : int, optional
|
||||
Number of iterations of the k-means algorithm to run. Note
|
||||
that this differs in meaning from the iters parameter to
|
||||
the kmeans function.
|
||||
thresh : float, optional
|
||||
(not used yet)
|
||||
minit : str, optional
|
||||
Method for initialization. Available methods are 'random',
|
||||
'points', '++' and 'matrix':
|
||||
|
||||
'random': generate k centroids from a Gaussian with mean and
|
||||
variance estimated from the data.
|
||||
|
||||
'points': choose k observations (rows) at random from data for
|
||||
the initial centroids.
|
||||
|
||||
'++': choose k observations accordingly to the kmeans++ method
|
||||
(careful seeding)
|
||||
|
||||
'matrix': interpret the k parameter as a k by M (or length k
|
||||
array for 1-D data) array of initial centroids.
|
||||
missing : str, optional
|
||||
Method to deal with empty clusters. Available methods are
|
||||
'warn' and 'raise':
|
||||
|
||||
'warn': give a warning and continue.
|
||||
|
||||
'raise': raise an ClusterError and terminate the algorithm.
|
||||
check_finite : bool, optional
|
||||
Whether to check that the input matrices contain only finite numbers.
|
||||
Disabling may give a performance gain, but may result in problems
|
||||
(crashes, non-termination) if the inputs do contain infinities or NaNs.
|
||||
Default: True
|
||||
seed : {None, int, `numpy.random.Generator`,
|
||||
`numpy.random.RandomState`}, optional
|
||||
|
||||
Seed for initializing the pseudo-random number generator.
|
||||
If `seed` is None (or `numpy.random`), the `numpy.random.RandomState`
|
||||
singleton is used.
|
||||
If `seed` is an int, a new ``RandomState`` instance is used,
|
||||
seeded with `seed`.
|
||||
If `seed` is already a ``Generator`` or ``RandomState`` instance then
|
||||
that instance is used.
|
||||
The default is None.
|
||||
|
||||
Returns
|
||||
-------
|
||||
centroid : ndarray
|
||||
A 'k' by 'N' array of centroids found at the last iteration of
|
||||
k-means.
|
||||
label : ndarray
|
||||
label[i] is the code or index of the centroid the
|
||||
ith observation is closest to.
|
||||
|
||||
See Also
|
||||
--------
|
||||
kmeans
|
||||
|
||||
References
|
||||
----------
|
||||
.. [1] D. Arthur and S. Vassilvitskii, "k-means++: the advantages of
|
||||
careful seeding", Proceedings of the Eighteenth Annual ACM-SIAM Symposium
|
||||
on Discrete Algorithms, 2007.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy.cluster.vq import kmeans2
|
||||
>>> import matplotlib.pyplot as plt
|
||||
|
||||
Create z, an array with shape (100, 2) containing a mixture of samples
|
||||
from three multivariate normal distributions.
|
||||
|
||||
>>> rng = np.random.default_rng()
|
||||
>>> a = rng.multivariate_normal([0, 6], [[2, 1], [1, 1.5]], size=45)
|
||||
>>> b = rng.multivariate_normal([2, 0], [[1, -1], [-1, 3]], size=30)
|
||||
>>> c = rng.multivariate_normal([6, 4], [[5, 0], [0, 1.2]], size=25)
|
||||
>>> z = np.concatenate((a, b, c))
|
||||
>>> rng.shuffle(z)
|
||||
|
||||
Compute three clusters.
|
||||
|
||||
>>> centroid, label = kmeans2(z, 3, minit='points')
|
||||
>>> centroid
|
||||
array([[ 2.22274463, -0.61666946], # may vary
|
||||
[ 0.54069047, 5.86541444],
|
||||
[ 6.73846769, 4.01991898]])
|
||||
|
||||
How many points are in each cluster?
|
||||
|
||||
>>> counts = np.bincount(label)
|
||||
>>> counts
|
||||
array([29, 51, 20]) # may vary
|
||||
|
||||
Plot the clusters.
|
||||
|
||||
>>> w0 = z[label == 0]
|
||||
>>> w1 = z[label == 1]
|
||||
>>> w2 = z[label == 2]
|
||||
>>> plt.plot(w0[:, 0], w0[:, 1], 'o', alpha=0.5, label='cluster 0')
|
||||
>>> plt.plot(w1[:, 0], w1[:, 1], 'd', alpha=0.5, label='cluster 1')
|
||||
>>> plt.plot(w2[:, 0], w2[:, 1], 's', alpha=0.5, label='cluster 2')
|
||||
>>> plt.plot(centroid[:, 0], centroid[:, 1], 'k*', label='centroids')
|
||||
>>> plt.axis('equal')
|
||||
>>> plt.legend(shadow=True)
|
||||
>>> plt.show()
|
||||
|
||||
"""
|
||||
if int(iter) < 1:
|
||||
raise ValueError("Invalid iter (%s), "
|
||||
"must be a positive integer." % iter)
|
||||
try:
|
||||
miss_meth = _valid_miss_meth[missing]
|
||||
except KeyError as e:
|
||||
raise ValueError("Unknown missing method %r" % (missing,)) from e
|
||||
|
||||
data = _asarray_validated(data, check_finite=check_finite)
|
||||
if data.ndim == 1:
|
||||
d = 1
|
||||
elif data.ndim == 2:
|
||||
d = data.shape[1]
|
||||
else:
|
||||
raise ValueError("Input of rank > 2 is not supported.")
|
||||
|
||||
if data.size < 1:
|
||||
raise ValueError("Empty input is not supported.")
|
||||
|
||||
# If k is not a single value, it should be compatible with data's shape
|
||||
if minit == 'matrix' or not np.isscalar(k):
|
||||
code_book = np.array(k, copy=True)
|
||||
if data.ndim != code_book.ndim:
|
||||
raise ValueError("k array doesn't match data rank")
|
||||
nc = len(code_book)
|
||||
if data.ndim > 1 and code_book.shape[1] != d:
|
||||
raise ValueError("k array doesn't match data dimension")
|
||||
else:
|
||||
nc = int(k)
|
||||
|
||||
if nc < 1:
|
||||
raise ValueError("Cannot ask kmeans2 for %d clusters"
|
||||
" (k was %s)" % (nc, k))
|
||||
elif nc != k:
|
||||
warnings.warn("k was not an integer, was converted.")
|
||||
|
||||
try:
|
||||
init_meth = _valid_init_meth[minit]
|
||||
except KeyError as e:
|
||||
raise ValueError("Unknown init method %r" % (minit,)) from e
|
||||
else:
|
||||
rng = check_random_state(seed)
|
||||
code_book = init_meth(data, k, rng)
|
||||
|
||||
for i in range(iter):
|
||||
# Compute the nearest neighbor for each obs using the current code book
|
||||
label = vq(data, code_book)[0]
|
||||
# Update the code book by computing centroids
|
||||
new_code_book, has_members = _vq.update_cluster_means(data, label, nc)
|
||||
if not has_members.all():
|
||||
miss_meth()
|
||||
# Set the empty clusters to their previous positions
|
||||
new_code_book[~has_members] = code_book[~has_members]
|
||||
code_book = new_code_book
|
||||
|
||||
return code_book, label
|
||||
Vendored
-55
@@ -1,55 +0,0 @@
|
||||
# Pytest customization
|
||||
import os
|
||||
import pytest
|
||||
import warnings
|
||||
|
||||
from distutils.version import LooseVersion
|
||||
import numpy as np
|
||||
from scipy._lib._fpumode import get_fpu_mode
|
||||
from scipy._lib._testutils import FPUModeChangeWarning
|
||||
|
||||
|
||||
def pytest_configure(config):
|
||||
config.addinivalue_line("markers",
|
||||
"slow: Tests that are very slow.")
|
||||
config.addinivalue_line("markers",
|
||||
"xslow: mark test as extremely slow (not run unless explicitly requested)")
|
||||
config.addinivalue_line("markers",
|
||||
"xfail_on_32bit: mark test as failing on 32-bit platforms")
|
||||
|
||||
|
||||
def _get_mark(item, name):
|
||||
if LooseVersion(pytest.__version__) >= LooseVersion("3.6.0"):
|
||||
mark = item.get_closest_marker(name)
|
||||
else:
|
||||
mark = item.get_marker(name)
|
||||
return mark
|
||||
|
||||
|
||||
def pytest_runtest_setup(item):
|
||||
mark = _get_mark(item, "xslow")
|
||||
if mark is not None:
|
||||
try:
|
||||
v = int(os.environ.get('SCIPY_XSLOW', '0'))
|
||||
except ValueError:
|
||||
v = False
|
||||
if not v:
|
||||
pytest.skip("very slow test; set environment variable SCIPY_XSLOW=1 to run it")
|
||||
mark = _get_mark(item, 'xfail_on_32bit')
|
||||
if mark is not None and np.intp(0).itemsize < 8:
|
||||
pytest.xfail('Fails on our 32-bit test platform(s): %s' % (mark.args[0],))
|
||||
|
||||
|
||||
@pytest.fixture(scope="function", autouse=True)
|
||||
def check_fpu_mode(request):
|
||||
"""
|
||||
Check FPU mode was not changed during the test.
|
||||
"""
|
||||
old_mode = get_fpu_mode()
|
||||
yield
|
||||
new_mode = get_fpu_mode()
|
||||
|
||||
if old_mode != new_mode:
|
||||
warnings.warn("FPU mode changed from {0:#x} to {1:#x} during "
|
||||
"the test".format(old_mode, new_mode),
|
||||
category=FPUModeChangeWarning, stacklevel=0)
|
||||
-338
@@ -1,338 +0,0 @@
|
||||
r"""
|
||||
==================================
|
||||
Constants (:mod:`scipy.constants`)
|
||||
==================================
|
||||
|
||||
.. currentmodule:: scipy.constants
|
||||
|
||||
Physical and mathematical constants and units.
|
||||
|
||||
|
||||
Mathematical constants
|
||||
======================
|
||||
|
||||
================ =================================================================
|
||||
``pi`` Pi
|
||||
``golden`` Golden ratio
|
||||
``golden_ratio`` Golden ratio
|
||||
================ =================================================================
|
||||
|
||||
|
||||
Physical constants
|
||||
==================
|
||||
|
||||
=========================== =================================================================
|
||||
``c`` speed of light in vacuum
|
||||
``speed_of_light`` speed of light in vacuum
|
||||
``mu_0`` the magnetic constant :math:`\mu_0`
|
||||
``epsilon_0`` the electric constant (vacuum permittivity), :math:`\epsilon_0`
|
||||
``h`` the Planck constant :math:`h`
|
||||
``Planck`` the Planck constant :math:`h`
|
||||
``hbar`` :math:`\hbar = h/(2\pi)`
|
||||
``G`` Newtonian constant of gravitation
|
||||
``gravitational_constant`` Newtonian constant of gravitation
|
||||
``g`` standard acceleration of gravity
|
||||
``e`` elementary charge
|
||||
``elementary_charge`` elementary charge
|
||||
``R`` molar gas constant
|
||||
``gas_constant`` molar gas constant
|
||||
``alpha`` fine-structure constant
|
||||
``fine_structure`` fine-structure constant
|
||||
``N_A`` Avogadro constant
|
||||
``Avogadro`` Avogadro constant
|
||||
``k`` Boltzmann constant
|
||||
``Boltzmann`` Boltzmann constant
|
||||
``sigma`` Stefan-Boltzmann constant :math:`\sigma`
|
||||
``Stefan_Boltzmann`` Stefan-Boltzmann constant :math:`\sigma`
|
||||
``Wien`` Wien displacement law constant
|
||||
``Rydberg`` Rydberg constant
|
||||
``m_e`` electron mass
|
||||
``electron_mass`` electron mass
|
||||
``m_p`` proton mass
|
||||
``proton_mass`` proton mass
|
||||
``m_n`` neutron mass
|
||||
``neutron_mass`` neutron mass
|
||||
=========================== =================================================================
|
||||
|
||||
|
||||
Constants database
|
||||
------------------
|
||||
|
||||
In addition to the above variables, :mod:`scipy.constants` also contains the
|
||||
2018 CODATA recommended values [CODATA2018]_ database containing more physical
|
||||
constants.
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
value -- Value in physical_constants indexed by key
|
||||
unit -- Unit in physical_constants indexed by key
|
||||
precision -- Relative precision in physical_constants indexed by key
|
||||
find -- Return list of physical_constant keys with a given string
|
||||
ConstantWarning -- Constant sought not in newest CODATA data set
|
||||
|
||||
.. data:: physical_constants
|
||||
|
||||
Dictionary of physical constants, of the format
|
||||
``physical_constants[name] = (value, unit, uncertainty)``.
|
||||
|
||||
Available constants:
|
||||
|
||||
====================================================================== ====
|
||||
%(constant_names)s
|
||||
====================================================================== ====
|
||||
|
||||
|
||||
Units
|
||||
=====
|
||||
|
||||
SI prefixes
|
||||
-----------
|
||||
|
||||
============ =================================================================
|
||||
``yotta`` :math:`10^{24}`
|
||||
``zetta`` :math:`10^{21}`
|
||||
``exa`` :math:`10^{18}`
|
||||
``peta`` :math:`10^{15}`
|
||||
``tera`` :math:`10^{12}`
|
||||
``giga`` :math:`10^{9}`
|
||||
``mega`` :math:`10^{6}`
|
||||
``kilo`` :math:`10^{3}`
|
||||
``hecto`` :math:`10^{2}`
|
||||
``deka`` :math:`10^{1}`
|
||||
``deci`` :math:`10^{-1}`
|
||||
``centi`` :math:`10^{-2}`
|
||||
``milli`` :math:`10^{-3}`
|
||||
``micro`` :math:`10^{-6}`
|
||||
``nano`` :math:`10^{-9}`
|
||||
``pico`` :math:`10^{-12}`
|
||||
``femto`` :math:`10^{-15}`
|
||||
``atto`` :math:`10^{-18}`
|
||||
``zepto`` :math:`10^{-21}`
|
||||
============ =================================================================
|
||||
|
||||
Binary prefixes
|
||||
---------------
|
||||
|
||||
============ =================================================================
|
||||
``kibi`` :math:`2^{10}`
|
||||
``mebi`` :math:`2^{20}`
|
||||
``gibi`` :math:`2^{30}`
|
||||
``tebi`` :math:`2^{40}`
|
||||
``pebi`` :math:`2^{50}`
|
||||
``exbi`` :math:`2^{60}`
|
||||
``zebi`` :math:`2^{70}`
|
||||
``yobi`` :math:`2^{80}`
|
||||
============ =================================================================
|
||||
|
||||
Mass
|
||||
----
|
||||
|
||||
================= ============================================================
|
||||
``gram`` :math:`10^{-3}` kg
|
||||
``metric_ton`` :math:`10^{3}` kg
|
||||
``grain`` one grain in kg
|
||||
``lb`` one pound (avoirdupous) in kg
|
||||
``pound`` one pound (avoirdupous) in kg
|
||||
``blob`` one inch version of a slug in kg (added in 1.0.0)
|
||||
``slinch`` one inch version of a slug in kg (added in 1.0.0)
|
||||
``slug`` one slug in kg (added in 1.0.0)
|
||||
``oz`` one ounce in kg
|
||||
``ounce`` one ounce in kg
|
||||
``stone`` one stone in kg
|
||||
``grain`` one grain in kg
|
||||
``long_ton`` one long ton in kg
|
||||
``short_ton`` one short ton in kg
|
||||
``troy_ounce`` one Troy ounce in kg
|
||||
``troy_pound`` one Troy pound in kg
|
||||
``carat`` one carat in kg
|
||||
``m_u`` atomic mass constant (in kg)
|
||||
``u`` atomic mass constant (in kg)
|
||||
``atomic_mass`` atomic mass constant (in kg)
|
||||
================= ============================================================
|
||||
|
||||
Angle
|
||||
-----
|
||||
|
||||
================= ============================================================
|
||||
``degree`` degree in radians
|
||||
``arcmin`` arc minute in radians
|
||||
``arcminute`` arc minute in radians
|
||||
``arcsec`` arc second in radians
|
||||
``arcsecond`` arc second in radians
|
||||
================= ============================================================
|
||||
|
||||
|
||||
Time
|
||||
----
|
||||
|
||||
================= ============================================================
|
||||
``minute`` one minute in seconds
|
||||
``hour`` one hour in seconds
|
||||
``day`` one day in seconds
|
||||
``week`` one week in seconds
|
||||
``year`` one year (365 days) in seconds
|
||||
``Julian_year`` one Julian year (365.25 days) in seconds
|
||||
================= ============================================================
|
||||
|
||||
|
||||
Length
|
||||
------
|
||||
|
||||
===================== ============================================================
|
||||
``inch`` one inch in meters
|
||||
``foot`` one foot in meters
|
||||
``yard`` one yard in meters
|
||||
``mile`` one mile in meters
|
||||
``mil`` one mil in meters
|
||||
``pt`` one point in meters
|
||||
``point`` one point in meters
|
||||
``survey_foot`` one survey foot in meters
|
||||
``survey_mile`` one survey mile in meters
|
||||
``nautical_mile`` one nautical mile in meters
|
||||
``fermi`` one Fermi in meters
|
||||
``angstrom`` one Angstrom in meters
|
||||
``micron`` one micron in meters
|
||||
``au`` one astronomical unit in meters
|
||||
``astronomical_unit`` one astronomical unit in meters
|
||||
``light_year`` one light year in meters
|
||||
``parsec`` one parsec in meters
|
||||
===================== ============================================================
|
||||
|
||||
Pressure
|
||||
--------
|
||||
|
||||
================= ============================================================
|
||||
``atm`` standard atmosphere in pascals
|
||||
``atmosphere`` standard atmosphere in pascals
|
||||
``bar`` one bar in pascals
|
||||
``torr`` one torr (mmHg) in pascals
|
||||
``mmHg`` one torr (mmHg) in pascals
|
||||
``psi`` one psi in pascals
|
||||
================= ============================================================
|
||||
|
||||
Area
|
||||
----
|
||||
|
||||
================= ============================================================
|
||||
``hectare`` one hectare in square meters
|
||||
``acre`` one acre in square meters
|
||||
================= ============================================================
|
||||
|
||||
|
||||
Volume
|
||||
------
|
||||
|
||||
=================== ========================================================
|
||||
``liter`` one liter in cubic meters
|
||||
``litre`` one liter in cubic meters
|
||||
``gallon`` one gallon (US) in cubic meters
|
||||
``gallon_US`` one gallon (US) in cubic meters
|
||||
``gallon_imp`` one gallon (UK) in cubic meters
|
||||
``fluid_ounce`` one fluid ounce (US) in cubic meters
|
||||
``fluid_ounce_US`` one fluid ounce (US) in cubic meters
|
||||
``fluid_ounce_imp`` one fluid ounce (UK) in cubic meters
|
||||
``bbl`` one barrel in cubic meters
|
||||
``barrel`` one barrel in cubic meters
|
||||
=================== ========================================================
|
||||
|
||||
Speed
|
||||
-----
|
||||
|
||||
================== ==========================================================
|
||||
``kmh`` kilometers per hour in meters per second
|
||||
``mph`` miles per hour in meters per second
|
||||
``mach`` one Mach (approx., at 15 C, 1 atm) in meters per second
|
||||
``speed_of_sound`` one Mach (approx., at 15 C, 1 atm) in meters per second
|
||||
``knot`` one knot in meters per second
|
||||
================== ==========================================================
|
||||
|
||||
|
||||
Temperature
|
||||
-----------
|
||||
|
||||
===================== =======================================================
|
||||
``zero_Celsius`` zero of Celsius scale in Kelvin
|
||||
``degree_Fahrenheit`` one Fahrenheit (only differences) in Kelvins
|
||||
===================== =======================================================
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
convert_temperature
|
||||
|
||||
Energy
|
||||
------
|
||||
|
||||
==================== =======================================================
|
||||
``eV`` one electron volt in Joules
|
||||
``electron_volt`` one electron volt in Joules
|
||||
``calorie`` one calorie (thermochemical) in Joules
|
||||
``calorie_th`` one calorie (thermochemical) in Joules
|
||||
``calorie_IT`` one calorie (International Steam Table calorie, 1956) in Joules
|
||||
``erg`` one erg in Joules
|
||||
``Btu`` one British thermal unit (International Steam Table) in Joules
|
||||
``Btu_IT`` one British thermal unit (International Steam Table) in Joules
|
||||
``Btu_th`` one British thermal unit (thermochemical) in Joules
|
||||
``ton_TNT`` one ton of TNT in Joules
|
||||
==================== =======================================================
|
||||
|
||||
Power
|
||||
-----
|
||||
|
||||
==================== =======================================================
|
||||
``hp`` one horsepower in watts
|
||||
``horsepower`` one horsepower in watts
|
||||
==================== =======================================================
|
||||
|
||||
Force
|
||||
-----
|
||||
|
||||
==================== =======================================================
|
||||
``dyn`` one dyne in newtons
|
||||
``dyne`` one dyne in newtons
|
||||
``lbf`` one pound force in newtons
|
||||
``pound_force`` one pound force in newtons
|
||||
``kgf`` one kilogram force in newtons
|
||||
``kilogram_force`` one kilogram force in newtons
|
||||
==================== =======================================================
|
||||
|
||||
Optics
|
||||
------
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
lambda2nu
|
||||
nu2lambda
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
.. [CODATA2018] CODATA Recommended Values of the Fundamental
|
||||
Physical Constants 2018.
|
||||
|
||||
https://physics.nist.gov/cuu/Constants/
|
||||
|
||||
"""
|
||||
# Modules contributed by BasSw (wegwerp@gmail.com)
|
||||
from .codata import *
|
||||
from .constants import *
|
||||
from .codata import _obsolete_constants
|
||||
|
||||
_constant_names = [(_k.lower(), _k, _v)
|
||||
for _k, _v in physical_constants.items()
|
||||
if _k not in _obsolete_constants]
|
||||
_constant_names = "\n".join(["``%s``%s %s %s" % (_x[1], " "*(66-len(_x[1])),
|
||||
_x[2][0], _x[2][1])
|
||||
for _x in sorted(_constant_names)])
|
||||
if __doc__:
|
||||
__doc__ = __doc__ % dict(constant_names=_constant_names)
|
||||
|
||||
del _constant_names
|
||||
|
||||
__all__ = [s for s in dir() if not s.startswith('_')]
|
||||
|
||||
from scipy._lib._testutils import PytestTester
|
||||
test = PytestTester(__name__)
|
||||
del PytestTester
|
||||
-1754
File diff suppressed because it is too large
Load Diff
-305
@@ -1,305 +0,0 @@
|
||||
"""
|
||||
Collection of physical constants and conversion factors.
|
||||
|
||||
Most constants are in SI units, so you can do
|
||||
print '10 mile per minute is', 10*mile/minute, 'm/s or', 10*mile/(minute*knot), 'knots'
|
||||
|
||||
The list is not meant to be comprehensive, but just convenient for everyday use.
|
||||
"""
|
||||
"""
|
||||
BasSw 2006
|
||||
physical constants: imported from CODATA
|
||||
unit conversion: see e.g., NIST special publication 811
|
||||
Use at own risk: double-check values before calculating your Mars orbit-insertion burn.
|
||||
Some constants exist in a few variants, which are marked with suffixes.
|
||||
The ones without any suffix should be the most common ones.
|
||||
"""
|
||||
|
||||
import math as _math
|
||||
from .codata import value as _cd
|
||||
import numpy as _np
|
||||
|
||||
# mathematical constants
|
||||
pi = _math.pi
|
||||
golden = golden_ratio = (1 + _math.sqrt(5)) / 2
|
||||
|
||||
# SI prefixes
|
||||
yotta = 1e24
|
||||
zetta = 1e21
|
||||
exa = 1e18
|
||||
peta = 1e15
|
||||
tera = 1e12
|
||||
giga = 1e9
|
||||
mega = 1e6
|
||||
kilo = 1e3
|
||||
hecto = 1e2
|
||||
deka = 1e1
|
||||
deci = 1e-1
|
||||
centi = 1e-2
|
||||
milli = 1e-3
|
||||
micro = 1e-6
|
||||
nano = 1e-9
|
||||
pico = 1e-12
|
||||
femto = 1e-15
|
||||
atto = 1e-18
|
||||
zepto = 1e-21
|
||||
|
||||
# binary prefixes
|
||||
kibi = 2**10
|
||||
mebi = 2**20
|
||||
gibi = 2**30
|
||||
tebi = 2**40
|
||||
pebi = 2**50
|
||||
exbi = 2**60
|
||||
zebi = 2**70
|
||||
yobi = 2**80
|
||||
|
||||
# physical constants
|
||||
c = speed_of_light = _cd('speed of light in vacuum')
|
||||
mu_0 = _cd('vacuum mag. permeability')
|
||||
epsilon_0 = _cd('vacuum electric permittivity')
|
||||
h = Planck = _cd('Planck constant')
|
||||
hbar = h / (2 * pi)
|
||||
G = gravitational_constant = _cd('Newtonian constant of gravitation')
|
||||
g = _cd('standard acceleration of gravity')
|
||||
e = elementary_charge = _cd('elementary charge')
|
||||
R = gas_constant = _cd('molar gas constant')
|
||||
alpha = fine_structure = _cd('fine-structure constant')
|
||||
N_A = Avogadro = _cd('Avogadro constant')
|
||||
k = Boltzmann = _cd('Boltzmann constant')
|
||||
sigma = Stefan_Boltzmann = _cd('Stefan-Boltzmann constant')
|
||||
Wien = _cd('Wien wavelength displacement law constant')
|
||||
Rydberg = _cd('Rydberg constant')
|
||||
|
||||
# mass in kg
|
||||
gram = 1e-3
|
||||
metric_ton = 1e3
|
||||
grain = 64.79891e-6
|
||||
lb = pound = 7000 * grain # avoirdupois
|
||||
blob = slinch = pound * g / 0.0254 # lbf*s**2/in (added in 1.0.0)
|
||||
slug = blob / 12 # lbf*s**2/foot (added in 1.0.0)
|
||||
oz = ounce = pound / 16
|
||||
stone = 14 * pound
|
||||
long_ton = 2240 * pound
|
||||
short_ton = 2000 * pound
|
||||
|
||||
troy_ounce = 480 * grain # only for metals / gems
|
||||
troy_pound = 12 * troy_ounce
|
||||
carat = 200e-6
|
||||
|
||||
m_e = electron_mass = _cd('electron mass')
|
||||
m_p = proton_mass = _cd('proton mass')
|
||||
m_n = neutron_mass = _cd('neutron mass')
|
||||
m_u = u = atomic_mass = _cd('atomic mass constant')
|
||||
|
||||
# angle in rad
|
||||
degree = pi / 180
|
||||
arcmin = arcminute = degree / 60
|
||||
arcsec = arcsecond = arcmin / 60
|
||||
|
||||
# time in second
|
||||
minute = 60.0
|
||||
hour = 60 * minute
|
||||
day = 24 * hour
|
||||
week = 7 * day
|
||||
year = 365 * day
|
||||
Julian_year = 365.25 * day
|
||||
|
||||
# length in meter
|
||||
inch = 0.0254
|
||||
foot = 12 * inch
|
||||
yard = 3 * foot
|
||||
mile = 1760 * yard
|
||||
mil = inch / 1000
|
||||
pt = point = inch / 72 # typography
|
||||
survey_foot = 1200.0 / 3937
|
||||
survey_mile = 5280 * survey_foot
|
||||
nautical_mile = 1852.0
|
||||
fermi = 1e-15
|
||||
angstrom = 1e-10
|
||||
micron = 1e-6
|
||||
au = astronomical_unit = 149597870700.0
|
||||
light_year = Julian_year * c
|
||||
parsec = au / arcsec
|
||||
|
||||
# pressure in pascal
|
||||
atm = atmosphere = _cd('standard atmosphere')
|
||||
bar = 1e5
|
||||
torr = mmHg = atm / 760
|
||||
psi = pound * g / (inch * inch)
|
||||
|
||||
# area in meter**2
|
||||
hectare = 1e4
|
||||
acre = 43560 * foot**2
|
||||
|
||||
# volume in meter**3
|
||||
litre = liter = 1e-3
|
||||
gallon = gallon_US = 231 * inch**3 # US
|
||||
# pint = gallon_US / 8
|
||||
fluid_ounce = fluid_ounce_US = gallon_US / 128
|
||||
bbl = barrel = 42 * gallon_US # for oil
|
||||
|
||||
gallon_imp = 4.54609e-3 # UK
|
||||
fluid_ounce_imp = gallon_imp / 160
|
||||
|
||||
# speed in meter per second
|
||||
kmh = 1e3 / hour
|
||||
mph = mile / hour
|
||||
mach = speed_of_sound = 340.5 # approx value at 15 degrees in 1 atm. Is this a common value?
|
||||
knot = nautical_mile / hour
|
||||
|
||||
# temperature in kelvin
|
||||
zero_Celsius = 273.15
|
||||
degree_Fahrenheit = 1/1.8 # only for differences
|
||||
|
||||
# energy in joule
|
||||
eV = electron_volt = elementary_charge # * 1 Volt
|
||||
calorie = calorie_th = 4.184
|
||||
calorie_IT = 4.1868
|
||||
erg = 1e-7
|
||||
Btu_th = pound * degree_Fahrenheit * calorie_th / gram
|
||||
Btu = Btu_IT = pound * degree_Fahrenheit * calorie_IT / gram
|
||||
ton_TNT = 1e9 * calorie_th
|
||||
# Wh = watt_hour
|
||||
|
||||
# power in watt
|
||||
hp = horsepower = 550 * foot * pound * g
|
||||
|
||||
# force in newton
|
||||
dyn = dyne = 1e-5
|
||||
lbf = pound_force = pound * g
|
||||
kgf = kilogram_force = g # * 1 kg
|
||||
|
||||
# functions for conversions that are not linear
|
||||
|
||||
|
||||
def convert_temperature(val, old_scale, new_scale):
|
||||
"""
|
||||
Convert from a temperature scale to another one among Celsius, Kelvin,
|
||||
Fahrenheit, and Rankine scales.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
val : array_like
|
||||
Value(s) of the temperature(s) to be converted expressed in the
|
||||
original scale.
|
||||
|
||||
old_scale: str
|
||||
Specifies as a string the original scale from which the temperature
|
||||
value(s) will be converted. Supported scales are Celsius ('Celsius',
|
||||
'celsius', 'C' or 'c'), Kelvin ('Kelvin', 'kelvin', 'K', 'k'),
|
||||
Fahrenheit ('Fahrenheit', 'fahrenheit', 'F' or 'f'), and Rankine
|
||||
('Rankine', 'rankine', 'R', 'r').
|
||||
|
||||
new_scale: str
|
||||
Specifies as a string the new scale to which the temperature
|
||||
value(s) will be converted. Supported scales are Celsius ('Celsius',
|
||||
'celsius', 'C' or 'c'), Kelvin ('Kelvin', 'kelvin', 'K', 'k'),
|
||||
Fahrenheit ('Fahrenheit', 'fahrenheit', 'F' or 'f'), and Rankine
|
||||
('Rankine', 'rankine', 'R', 'r').
|
||||
|
||||
Returns
|
||||
-------
|
||||
res : float or array of floats
|
||||
Value(s) of the converted temperature(s) expressed in the new scale.
|
||||
|
||||
Notes
|
||||
-----
|
||||
.. versionadded:: 0.18.0
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy.constants import convert_temperature
|
||||
>>> convert_temperature(np.array([-40, 40]), 'Celsius', 'Kelvin')
|
||||
array([ 233.15, 313.15])
|
||||
|
||||
"""
|
||||
# Convert from `old_scale` to Kelvin
|
||||
if old_scale.lower() in ['celsius', 'c']:
|
||||
tempo = _np.asanyarray(val) + zero_Celsius
|
||||
elif old_scale.lower() in ['kelvin', 'k']:
|
||||
tempo = _np.asanyarray(val)
|
||||
elif old_scale.lower() in ['fahrenheit', 'f']:
|
||||
tempo = (_np.asanyarray(val) - 32) * 5 / 9 + zero_Celsius
|
||||
elif old_scale.lower() in ['rankine', 'r']:
|
||||
tempo = _np.asanyarray(val) * 5 / 9
|
||||
else:
|
||||
raise NotImplementedError("%s scale is unsupported: supported scales "
|
||||
"are Celsius, Kelvin, Fahrenheit, and "
|
||||
"Rankine" % old_scale)
|
||||
# and from Kelvin to `new_scale`.
|
||||
if new_scale.lower() in ['celsius', 'c']:
|
||||
res = tempo - zero_Celsius
|
||||
elif new_scale.lower() in ['kelvin', 'k']:
|
||||
res = tempo
|
||||
elif new_scale.lower() in ['fahrenheit', 'f']:
|
||||
res = (tempo - zero_Celsius) * 9 / 5 + 32
|
||||
elif new_scale.lower() in ['rankine', 'r']:
|
||||
res = tempo * 9 / 5
|
||||
else:
|
||||
raise NotImplementedError("'%s' scale is unsupported: supported "
|
||||
"scales are 'Celsius', 'Kelvin', "
|
||||
"'Fahrenheit', and 'Rankine'" % new_scale)
|
||||
|
||||
return res
|
||||
|
||||
|
||||
# optics
|
||||
|
||||
|
||||
def lambda2nu(lambda_):
|
||||
"""
|
||||
Convert wavelength to optical frequency
|
||||
|
||||
Parameters
|
||||
----------
|
||||
lambda_ : array_like
|
||||
Wavelength(s) to be converted.
|
||||
|
||||
Returns
|
||||
-------
|
||||
nu : float or array of floats
|
||||
Equivalent optical frequency.
|
||||
|
||||
Notes
|
||||
-----
|
||||
Computes ``nu = c / lambda`` where c = 299792458.0, i.e., the
|
||||
(vacuum) speed of light in meters/second.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy.constants import lambda2nu, speed_of_light
|
||||
>>> lambda2nu(np.array((1, speed_of_light)))
|
||||
array([ 2.99792458e+08, 1.00000000e+00])
|
||||
|
||||
"""
|
||||
return c / _np.asanyarray(lambda_)
|
||||
|
||||
|
||||
def nu2lambda(nu):
|
||||
"""
|
||||
Convert optical frequency to wavelength.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
nu : array_like
|
||||
Optical frequency to be converted.
|
||||
|
||||
Returns
|
||||
-------
|
||||
lambda : float or array of floats
|
||||
Equivalent wavelength(s).
|
||||
|
||||
Notes
|
||||
-----
|
||||
Computes ``lambda = c / nu`` where c = 299792458.0, i.e., the
|
||||
(vacuum) speed of light in meters/second.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy.constants import nu2lambda, speed_of_light
|
||||
>>> nu2lambda(np.array((1, speed_of_light)))
|
||||
array([ 2.99792458e+08, 1.00000000e+00])
|
||||
|
||||
"""
|
||||
return c / _np.asanyarray(nu)
|
||||
Vendored
-11
@@ -1,11 +0,0 @@
|
||||
|
||||
def configuration(parent_package='', top_path=None):
|
||||
from numpy.distutils.misc_util import Configuration
|
||||
config = Configuration('constants', parent_package, top_path)
|
||||
config.add_data_dir('tests')
|
||||
return config
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
from numpy.distutils.core import setup
|
||||
setup(**configuration(top_path='').todict())
|
||||
@@ -1,57 +0,0 @@
|
||||
from scipy.constants import constants, codata, find, value, ConstantWarning
|
||||
from numpy.testing import (assert_equal, assert_, assert_almost_equal,
|
||||
suppress_warnings)
|
||||
|
||||
|
||||
def test_find():
|
||||
keys = find('weak mixing', disp=False)
|
||||
assert_equal(keys, ['weak mixing angle'])
|
||||
|
||||
keys = find('qwertyuiop', disp=False)
|
||||
assert_equal(keys, [])
|
||||
|
||||
keys = find('natural unit', disp=False)
|
||||
assert_equal(keys, sorted(['natural unit of velocity',
|
||||
'natural unit of action',
|
||||
'natural unit of action in eV s',
|
||||
'natural unit of mass',
|
||||
'natural unit of energy',
|
||||
'natural unit of energy in MeV',
|
||||
'natural unit of momentum',
|
||||
'natural unit of momentum in MeV/c',
|
||||
'natural unit of length',
|
||||
'natural unit of time']))
|
||||
|
||||
|
||||
def test_basic_table_parse():
|
||||
c = 'speed of light in vacuum'
|
||||
assert_equal(codata.value(c), constants.c)
|
||||
assert_equal(codata.value(c), constants.speed_of_light)
|
||||
|
||||
|
||||
def test_basic_lookup():
|
||||
assert_equal('%d %s' % (codata.c, codata.unit('speed of light in vacuum')),
|
||||
'299792458 m s^-1')
|
||||
|
||||
|
||||
def test_find_all():
|
||||
assert_(len(codata.find(disp=False)) > 300)
|
||||
|
||||
|
||||
def test_find_single():
|
||||
assert_equal(codata.find('Wien freq', disp=False)[0],
|
||||
'Wien frequency displacement law constant')
|
||||
|
||||
|
||||
def test_2002_vs_2006():
|
||||
assert_almost_equal(codata.value('magn. flux quantum'),
|
||||
codata.value('mag. flux quantum'))
|
||||
|
||||
|
||||
def test_exact_values():
|
||||
# Check that updating stored values with exact ones worked.
|
||||
with suppress_warnings() as sup:
|
||||
sup.filter(ConstantWarning)
|
||||
for key in codata.exact_values:
|
||||
assert_((codata.exact_values[key][0] - value(key)) / value(key) == 0)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
from numpy.testing import assert_equal, assert_allclose
|
||||
import scipy.constants as sc
|
||||
|
||||
|
||||
def test_convert_temperature():
|
||||
assert_equal(sc.convert_temperature(32, 'f', 'Celsius'), 0)
|
||||
assert_equal(sc.convert_temperature([0, 0], 'celsius', 'Kelvin'),
|
||||
[273.15, 273.15])
|
||||
assert_equal(sc.convert_temperature([0, 0], 'kelvin', 'c'),
|
||||
[-273.15, -273.15])
|
||||
assert_equal(sc.convert_temperature([32, 32], 'f', 'k'), [273.15, 273.15])
|
||||
assert_equal(sc.convert_temperature([273.15, 273.15], 'kelvin', 'F'),
|
||||
[32, 32])
|
||||
assert_equal(sc.convert_temperature([0, 0], 'C', 'fahrenheit'), [32, 32])
|
||||
assert_allclose(sc.convert_temperature([0, 0], 'c', 'r'), [491.67, 491.67],
|
||||
rtol=0., atol=1e-13)
|
||||
assert_allclose(sc.convert_temperature([491.67, 491.67], 'Rankine', 'C'),
|
||||
[0., 0.], rtol=0., atol=1e-13)
|
||||
assert_allclose(sc.convert_temperature([491.67, 491.67], 'r', 'F'),
|
||||
[32., 32.], rtol=0., atol=1e-13)
|
||||
assert_allclose(sc.convert_temperature([32, 32], 'fahrenheit', 'R'),
|
||||
[491.67, 491.67], rtol=0., atol=1e-13)
|
||||
assert_allclose(sc.convert_temperature([273.15, 273.15], 'K', 'R'),
|
||||
[491.67, 491.67], rtol=0., atol=1e-13)
|
||||
assert_allclose(sc.convert_temperature([491.67, 0.], 'rankine', 'kelvin'),
|
||||
[273.15, 0.], rtol=0., atol=1e-13)
|
||||
|
||||
|
||||
def test_lambda_to_nu():
|
||||
assert_equal(sc.lambda2nu([sc.speed_of_light, 1]), [1, sc.speed_of_light])
|
||||
|
||||
|
||||
def test_nu_to_lambda():
|
||||
assert_equal(sc.nu2lambda([sc.speed_of_light, 1]), [1, sc.speed_of_light])
|
||||
|
||||
-6
@@ -1,6 +0,0 @@
|
||||
# Note: this should disappear at some point. For now, please keep it
|
||||
# in sync with the doc dependencies in pyproject.toml
|
||||
Sphinx!=3.1.0, !=4.1.0
|
||||
pydata-sphinx-theme>=0.6.1
|
||||
sphinx-panels>=0.5.2
|
||||
matplotlib>2
|
||||
Vendored
-111
@@ -1,111 +0,0 @@
|
||||
"""
|
||||
==============================================
|
||||
Discrete Fourier transforms (:mod:`scipy.fft`)
|
||||
==============================================
|
||||
|
||||
.. currentmodule:: scipy.fft
|
||||
|
||||
Fast Fourier Transforms (FFTs)
|
||||
==============================
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
fft - Fast (discrete) Fourier Transform (FFT)
|
||||
ifft - Inverse FFT
|
||||
fft2 - 2-D FFT
|
||||
ifft2 - 2-D inverse FFT
|
||||
fftn - N-D FFT
|
||||
ifftn - N-D inverse FFT
|
||||
rfft - FFT of strictly real-valued sequence
|
||||
irfft - Inverse of rfft
|
||||
rfft2 - 2-D FFT of real sequence
|
||||
irfft2 - Inverse of rfft2
|
||||
rfftn - N-D FFT of real sequence
|
||||
irfftn - Inverse of rfftn
|
||||
hfft - FFT of a Hermitian sequence (real spectrum)
|
||||
ihfft - Inverse of hfft
|
||||
hfft2 - 2-D FFT of a Hermitian sequence
|
||||
ihfft2 - Inverse of hfft2
|
||||
hfftn - N-D FFT of a Hermitian sequence
|
||||
ihfftn - Inverse of hfftn
|
||||
|
||||
Discrete Sin and Cosine Transforms (DST and DCT)
|
||||
================================================
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
dct - Discrete cosine transform
|
||||
idct - Inverse discrete cosine transform
|
||||
dctn - N-D Discrete cosine transform
|
||||
idctn - N-D Inverse discrete cosine transform
|
||||
dst - Discrete sine transform
|
||||
idst - Inverse discrete sine transform
|
||||
dstn - N-D Discrete sine transform
|
||||
idstn - N-D Inverse discrete sine transform
|
||||
|
||||
Fast Hankel Transforms
|
||||
======================
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
fht - Fast Hankel transform
|
||||
ifht - Inverse of fht
|
||||
|
||||
Helper functions
|
||||
================
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
fftshift - Shift the zero-frequency component to the center of the spectrum
|
||||
ifftshift - The inverse of `fftshift`
|
||||
fftfreq - Return the Discrete Fourier Transform sample frequencies
|
||||
rfftfreq - DFT sample frequencies (for usage with rfft, irfft)
|
||||
fhtoffset - Compute an optimal offset for the Fast Hankel Transform
|
||||
next_fast_len - Find the optimal length to zero-pad an FFT for speed
|
||||
set_workers - Context manager to set default number of workers
|
||||
get_workers - Get the current default number of workers
|
||||
|
||||
Backend control
|
||||
===============
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated/
|
||||
|
||||
set_backend - Context manager to set the backend within a fixed scope
|
||||
skip_backend - Context manager to skip a backend within a fixed scope
|
||||
set_global_backend - Sets the global fft backend
|
||||
register_backend - Register a backend for permanent use
|
||||
|
||||
"""
|
||||
|
||||
from ._basic import (
|
||||
fft, ifft, fft2, ifft2, fftn, ifftn,
|
||||
rfft, irfft, rfft2, irfft2, rfftn, irfftn,
|
||||
hfft, ihfft, hfft2, ihfft2, hfftn, ihfftn)
|
||||
from ._realtransforms import dct, idct, dst, idst, dctn, idctn, dstn, idstn
|
||||
from ._fftlog import fht, ifht, fhtoffset
|
||||
from ._helper import next_fast_len
|
||||
from ._backend import (set_backend, skip_backend, set_global_backend,
|
||||
register_backend)
|
||||
from numpy.fft import fftfreq, rfftfreq, fftshift, ifftshift
|
||||
from ._pocketfft.helper import set_workers, get_workers
|
||||
|
||||
__all__ = [
|
||||
'fft', 'ifft', 'fft2','ifft2', 'fftn', 'ifftn',
|
||||
'rfft', 'irfft', 'rfft2', 'irfft2', 'rfftn', 'irfftn',
|
||||
'hfft', 'ihfft', 'hfft2', 'ihfft2', 'hfftn', 'ihfftn',
|
||||
'fftfreq', 'rfftfreq', 'fftshift', 'ifftshift',
|
||||
'next_fast_len',
|
||||
'dct', 'idct', 'dst', 'idst', 'dctn', 'idctn', 'dstn', 'idstn',
|
||||
'fht', 'ifht',
|
||||
'fhtoffset',
|
||||
'set_backend', 'skip_backend', 'set_global_backend', 'register_backend',
|
||||
'get_workers', 'set_workers']
|
||||
|
||||
|
||||
from scipy._lib._testutils import PytestTester
|
||||
test = PytestTester(__name__)
|
||||
del PytestTester
|
||||
Vendored
-180
@@ -1,180 +0,0 @@
|
||||
import scipy._lib.uarray as ua
|
||||
from . import _pocketfft
|
||||
|
||||
|
||||
class _ScipyBackend:
|
||||
"""The default backend for fft calculations
|
||||
|
||||
Notes
|
||||
-----
|
||||
We use the domain ``numpy.scipy`` rather than ``scipy`` because in the
|
||||
future, ``uarray`` will treat the domain as a hierarchy. This means the user
|
||||
can install a single backend for ``numpy`` and have it implement
|
||||
``numpy.scipy.fft`` as well.
|
||||
"""
|
||||
__ua_domain__ = "numpy.scipy.fft"
|
||||
|
||||
@staticmethod
|
||||
def __ua_function__(method, args, kwargs):
|
||||
fn = getattr(_pocketfft, method.__name__, None)
|
||||
|
||||
if fn is None:
|
||||
return NotImplemented
|
||||
return fn(*args, **kwargs)
|
||||
|
||||
|
||||
_named_backends = {
|
||||
'scipy': _ScipyBackend,
|
||||
}
|
||||
|
||||
|
||||
def _backend_from_arg(backend):
|
||||
"""Maps strings to known backends and validates the backend"""
|
||||
|
||||
if isinstance(backend, str):
|
||||
try:
|
||||
backend = _named_backends[backend]
|
||||
except KeyError as e:
|
||||
raise ValueError('Unknown backend {}'.format(backend)) from e
|
||||
|
||||
if backend.__ua_domain__ != 'numpy.scipy.fft':
|
||||
raise ValueError('Backend does not implement "numpy.scipy.fft"')
|
||||
|
||||
return backend
|
||||
|
||||
|
||||
def set_global_backend(backend):
|
||||
"""Sets the global fft backend
|
||||
|
||||
The global backend has higher priority than registered backends, but lower
|
||||
priority than context-specific backends set with `set_backend`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend : {object, 'scipy'}
|
||||
The backend to use.
|
||||
Can either be a ``str`` containing the name of a known backend
|
||||
{'scipy'} or an object that implements the uarray protocol.
|
||||
|
||||
Raises
|
||||
------
|
||||
ValueError: If the backend does not implement ``numpy.scipy.fft``.
|
||||
|
||||
Notes
|
||||
-----
|
||||
This will overwrite the previously set global backend, which, by default, is
|
||||
the SciPy implementation.
|
||||
|
||||
Examples
|
||||
--------
|
||||
We can set the global fft backend:
|
||||
|
||||
>>> from scipy.fft import fft, set_global_backend
|
||||
>>> set_global_backend("scipy") # Sets global backend. "scipy" is the default backend.
|
||||
>>> fft([1]) # Calls the global backend
|
||||
array([1.+0.j])
|
||||
"""
|
||||
backend = _backend_from_arg(backend)
|
||||
ua.set_global_backend(backend)
|
||||
|
||||
|
||||
def register_backend(backend):
|
||||
"""
|
||||
Register a backend for permanent use.
|
||||
|
||||
Registered backends have the lowest priority and will be tried after the
|
||||
global backend.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend : {object, 'scipy'}
|
||||
The backend to use.
|
||||
Can either be a ``str`` containing the name of a known backend
|
||||
{'scipy'} or an object that implements the uarray protocol.
|
||||
|
||||
Raises
|
||||
------
|
||||
ValueError: If the backend does not implement ``numpy.scipy.fft``.
|
||||
|
||||
Examples
|
||||
--------
|
||||
We can register a new fft backend:
|
||||
|
||||
>>> from scipy.fft import fft, register_backend, set_global_backend
|
||||
>>> class NoopBackend: # Define an invalid Backend
|
||||
... __ua_domain__ = "numpy.scipy.fft"
|
||||
... def __ua_function__(self, func, args, kwargs):
|
||||
... return NotImplemented
|
||||
>>> set_global_backend(NoopBackend()) # Set the invalid backend as global
|
||||
>>> register_backend("scipy") # Register a new backend
|
||||
>>> fft([1]) # The registered backend is called because the global backend returns `NotImplemented`
|
||||
array([1.+0.j])
|
||||
>>> set_global_backend("scipy") # Restore global backend to default
|
||||
|
||||
"""
|
||||
backend = _backend_from_arg(backend)
|
||||
ua.register_backend(backend)
|
||||
|
||||
|
||||
def set_backend(backend, coerce=False, only=False):
|
||||
"""Context manager to set the backend within a fixed scope.
|
||||
|
||||
Upon entering the ``with`` statement, the given backend will be added to
|
||||
the list of available backends with the highest priority. Upon exit, the
|
||||
backend is reset to the state before entering the scope.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend : {object, 'scipy'}
|
||||
The backend to use.
|
||||
Can either be a ``str`` containing the name of a known backend
|
||||
{'scipy'} or an object that implements the uarray protocol.
|
||||
coerce : bool, optional
|
||||
Whether to allow expensive conversions for the ``x`` parameter. e.g.,
|
||||
copying a NumPy array to the GPU for a CuPy backend. Implies ``only``.
|
||||
only : bool, optional
|
||||
If only is ``True`` and this backend returns ``NotImplemented``, then a
|
||||
BackendNotImplemented error will be raised immediately. Ignoring any
|
||||
lower priority backends.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> import scipy.fft as fft
|
||||
>>> with fft.set_backend('scipy', only=True):
|
||||
... fft.fft([1]) # Always calls the scipy implementation
|
||||
array([1.+0.j])
|
||||
"""
|
||||
backend = _backend_from_arg(backend)
|
||||
return ua.set_backend(backend, coerce=coerce, only=only)
|
||||
|
||||
|
||||
def skip_backend(backend):
|
||||
"""Context manager to skip a backend within a fixed scope.
|
||||
|
||||
Within the context of a ``with`` statement, the given backend will not be
|
||||
called. This covers backends registered both locally and globally. Upon
|
||||
exit, the backend will again be considered.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
backend : {object, 'scipy'}
|
||||
The backend to skip.
|
||||
Can either be a ``str`` containing the name of a known backend
|
||||
{'scipy'} or an object that implements the uarray protocol.
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> import scipy.fft as fft
|
||||
>>> fft.fft([1]) # Calls default SciPy backend
|
||||
array([1.+0.j])
|
||||
>>> with fft.skip_backend('scipy'): # We explicitly skip the SciPy backend
|
||||
... fft.fft([1]) # leaving no implementation available
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
BackendNotImplementedError: No selected backends had an implementation ...
|
||||
"""
|
||||
backend = _backend_from_arg(backend)
|
||||
return ua.skip_backend(backend)
|
||||
|
||||
|
||||
set_global_backend('scipy')
|
||||
Vendored
-1620
File diff suppressed because it is too large
Load Diff
-22
@@ -1,22 +0,0 @@
|
||||
import numpy as np
|
||||
|
||||
class NumPyBackend:
|
||||
"""Backend that uses numpy.fft"""
|
||||
__ua_domain__ = "numpy.scipy.fft"
|
||||
|
||||
@staticmethod
|
||||
def __ua_function__(method, args, kwargs):
|
||||
kwargs.pop("overwrite_x", None)
|
||||
|
||||
fn = getattr(np.fft, method.__name__, None)
|
||||
return (NotImplemented if fn is None
|
||||
else fn(*args, **kwargs))
|
||||
|
||||
|
||||
class EchoBackend:
|
||||
"""Backend that just prints the __ua_function__ arguments"""
|
||||
__ua_domain__ = "numpy.scipy.fft"
|
||||
|
||||
@staticmethod
|
||||
def __ua_function__(method, args, kwargs):
|
||||
print(method, args, kwargs, sep='\n')
|
||||
Vendored
-327
@@ -1,327 +0,0 @@
|
||||
'''Fast Hankel transforms using the FFTLog algorithm.
|
||||
|
||||
The implementation closely follows the Fortran code of Hamilton (2000).
|
||||
|
||||
added: 14/11/2020 Nicolas Tessore <n.tessore@ucl.ac.uk>
|
||||
'''
|
||||
|
||||
import numpy as np
|
||||
from warnings import warn
|
||||
from ._basic import rfft, irfft
|
||||
from ..special import loggamma, poch
|
||||
|
||||
__all__ = [
|
||||
'fht', 'ifht',
|
||||
'fhtoffset',
|
||||
]
|
||||
|
||||
|
||||
# constants
|
||||
LN_2 = np.log(2)
|
||||
|
||||
|
||||
def fht(a, dln, mu, offset=0.0, bias=0.0):
|
||||
r'''Compute the fast Hankel transform.
|
||||
|
||||
Computes the discrete Hankel transform of a logarithmically spaced periodic
|
||||
sequence using the FFTLog algorithm [1]_, [2]_.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
a : array_like (..., n)
|
||||
Real periodic input array, uniformly logarithmically spaced. For
|
||||
multidimensional input, the transform is performed over the last axis.
|
||||
dln : float
|
||||
Uniform logarithmic spacing of the input array.
|
||||
mu : float
|
||||
Order of the Hankel transform, any positive or negative real number.
|
||||
offset : float, optional
|
||||
Offset of the uniform logarithmic spacing of the output array.
|
||||
bias : float, optional
|
||||
Exponent of power law bias, any positive or negative real number.
|
||||
|
||||
Returns
|
||||
-------
|
||||
A : array_like (..., n)
|
||||
The transformed output array, which is real, periodic, uniformly
|
||||
logarithmically spaced, and of the same shape as the input array.
|
||||
|
||||
See Also
|
||||
--------
|
||||
ifht : The inverse of `fht`.
|
||||
fhtoffset : Return an optimal offset for `fht`.
|
||||
|
||||
Notes
|
||||
-----
|
||||
This function computes a discrete version of the Hankel transform
|
||||
|
||||
.. math::
|
||||
|
||||
A(k) = \int_{0}^{\infty} \! a(r) \, J_\mu(kr) \, k \, dr \;,
|
||||
|
||||
where :math:`J_\mu` is the Bessel function of order :math:`\mu`. The index
|
||||
:math:`\mu` may be any real number, positive or negative.
|
||||
|
||||
The input array `a` is a periodic sequence of length :math:`n`, uniformly
|
||||
logarithmically spaced with spacing `dln`,
|
||||
|
||||
.. math::
|
||||
|
||||
a_j = a(r_j) \;, \quad
|
||||
r_j = r_c \exp[(j-j_c) \, \mathtt{dln}]
|
||||
|
||||
centred about the point :math:`r_c`. Note that the central index
|
||||
:math:`j_c = (n+1)/2` is half-integral if :math:`n` is even, so that
|
||||
:math:`r_c` falls between two input elements. Similarly, the output
|
||||
array `A` is a periodic sequence of length :math:`n`, also uniformly
|
||||
logarithmically spaced with spacing `dln`
|
||||
|
||||
.. math::
|
||||
|
||||
A_j = A(k_j) \;, \quad
|
||||
k_j = k_c \exp[(j-j_c) \, \mathtt{dln}]
|
||||
|
||||
centred about the point :math:`k_c`.
|
||||
|
||||
The centre points :math:`r_c` and :math:`k_c` of the periodic intervals may
|
||||
be chosen arbitrarily, but it would be usual to choose the product
|
||||
:math:`k_c r_c = k_j r_{n-1-j} = k_{n-1-j} r_j` to be unity. This can be
|
||||
changed using the `offset` parameter, which controls the logarithmic offset
|
||||
:math:`\log(k_c) = \mathtt{offset} - \log(r_c)` of the output array.
|
||||
Choosing an optimal value for `offset` may reduce ringing of the discrete
|
||||
Hankel transform.
|
||||
|
||||
If the `bias` parameter is nonzero, this function computes a discrete
|
||||
version of the biased Hankel transform
|
||||
|
||||
.. math::
|
||||
|
||||
A(k) = \int_{0}^{\infty} \! a_q(r) \, (kr)^q \, J_\mu(kr) \, k \, dr
|
||||
|
||||
where :math:`q` is the value of `bias`, and a power law bias
|
||||
:math:`a_q(r) = a(r) \, (kr)^{-q}` is applied to the input sequence.
|
||||
Biasing the transform can help approximate the continuous transform of
|
||||
:math:`a(r)` if there is a value :math:`q` such that :math:`a_q(r)` is
|
||||
close to a periodic sequence, in which case the resulting :math:`A(k)` will
|
||||
be close to the continuous transform.
|
||||
|
||||
References
|
||||
----------
|
||||
.. [1] Talman J. D., 1978, J. Comp. Phys., 29, 35
|
||||
.. [2] Hamilton A. J. S., 2000, MNRAS, 312, 257 (astro-ph/9905191)
|
||||
|
||||
'''
|
||||
|
||||
# size of transform
|
||||
n = np.shape(a)[-1]
|
||||
|
||||
# bias input array
|
||||
if bias != 0:
|
||||
# a_q(r) = a(r) (r/r_c)^{-q}
|
||||
j_c = (n-1)/2
|
||||
j = np.arange(n)
|
||||
a = a * np.exp(-bias*(j - j_c)*dln)
|
||||
|
||||
# compute FHT coefficients
|
||||
u = fhtcoeff(n, dln, mu, offset=offset, bias=bias)
|
||||
|
||||
# transform
|
||||
A = _fhtq(a, u)
|
||||
|
||||
# bias output array
|
||||
if bias != 0:
|
||||
# A(k) = A_q(k) (k/k_c)^{-q} (k_c r_c)^{-q}
|
||||
A *= np.exp(-bias*((j - j_c)*dln + offset))
|
||||
|
||||
return A
|
||||
|
||||
|
||||
def ifht(A, dln, mu, offset=0.0, bias=0.0):
|
||||
r'''Compute the inverse fast Hankel transform.
|
||||
|
||||
Computes the discrete inverse Hankel transform of a logarithmically spaced
|
||||
periodic sequence. This is the inverse operation to `fht`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
A : array_like (..., n)
|
||||
Real periodic input array, uniformly logarithmically spaced. For
|
||||
multidimensional input, the transform is performed over the last axis.
|
||||
dln : float
|
||||
Uniform logarithmic spacing of the input array.
|
||||
mu : float
|
||||
Order of the Hankel transform, any positive or negative real number.
|
||||
offset : float, optional
|
||||
Offset of the uniform logarithmic spacing of the output array.
|
||||
bias : float, optional
|
||||
Exponent of power law bias, any positive or negative real number.
|
||||
|
||||
Returns
|
||||
-------
|
||||
a : array_like (..., n)
|
||||
The transformed output array, which is real, periodic, uniformly
|
||||
logarithmically spaced, and of the same shape as the input array.
|
||||
|
||||
See Also
|
||||
--------
|
||||
fht : Definition of the fast Hankel transform.
|
||||
fhtoffset : Return an optimal offset for `ifht`.
|
||||
|
||||
Notes
|
||||
-----
|
||||
This function computes a discrete version of the Hankel transform
|
||||
|
||||
.. math::
|
||||
|
||||
a(r) = \int_{0}^{\infty} \! A(k) \, J_\mu(kr) \, r \, dk \;,
|
||||
|
||||
where :math:`J_\mu` is the Bessel function of order :math:`\mu`. The index
|
||||
:math:`\mu` may be any real number, positive or negative.
|
||||
|
||||
See `fht` for further details.
|
||||
|
||||
'''
|
||||
|
||||
# size of transform
|
||||
n = np.shape(A)[-1]
|
||||
|
||||
# bias input array
|
||||
if bias != 0:
|
||||
# A_q(k) = A(k) (k/k_c)^{q} (k_c r_c)^{q}
|
||||
j_c = (n-1)/2
|
||||
j = np.arange(n)
|
||||
A = A * np.exp(bias*((j - j_c)*dln + offset))
|
||||
|
||||
# compute FHT coefficients
|
||||
u = fhtcoeff(n, dln, mu, offset=offset, bias=bias)
|
||||
|
||||
# transform
|
||||
a = _fhtq(A, u, inverse=True)
|
||||
|
||||
# bias output array
|
||||
if bias != 0:
|
||||
# a(r) = a_q(r) (r/r_c)^{q}
|
||||
a /= np.exp(-bias*(j - j_c)*dln)
|
||||
|
||||
return a
|
||||
|
||||
|
||||
def fhtcoeff(n, dln, mu, offset=0.0, bias=0.0):
|
||||
'''Compute the coefficient array for a fast Hankel transform.
|
||||
'''
|
||||
|
||||
lnkr, q = offset, bias
|
||||
|
||||
# Hankel transform coefficients
|
||||
# u_m = (kr)^{-i 2m pi/(n dlnr)} U_mu(q + i 2m pi/(n dlnr))
|
||||
# with U_mu(x) = 2^x Gamma((mu+1+x)/2)/Gamma((mu+1-x)/2)
|
||||
xp = (mu+1+q)/2
|
||||
xm = (mu+1-q)/2
|
||||
y = np.linspace(0, np.pi*(n//2)/(n*dln), n//2+1)
|
||||
u = np.empty(n//2+1, dtype=complex)
|
||||
v = np.empty(n//2+1, dtype=complex)
|
||||
u.imag[:] = y
|
||||
u.real[:] = xm
|
||||
loggamma(u, out=v)
|
||||
u.real[:] = xp
|
||||
loggamma(u, out=u)
|
||||
y *= 2*(LN_2 - lnkr)
|
||||
u.real -= v.real
|
||||
u.real += LN_2*q
|
||||
u.imag += v.imag
|
||||
u.imag += y
|
||||
np.exp(u, out=u)
|
||||
|
||||
# fix last coefficient to be real
|
||||
u.imag[-1] = 0
|
||||
|
||||
# deal with special cases
|
||||
if not np.isfinite(u[0]):
|
||||
# write u_0 = 2^q Gamma(xp)/Gamma(xm) = 2^q poch(xm, xp-xm)
|
||||
# poch() handles special cases for negative integers correctly
|
||||
u[0] = 2**q * poch(xm, xp-xm)
|
||||
# the coefficient may be inf or 0, meaning the transform or the
|
||||
# inverse transform, respectively, is singular
|
||||
|
||||
return u
|
||||
|
||||
|
||||
def fhtoffset(dln, mu, initial=0.0, bias=0.0):
|
||||
'''Return optimal offset for a fast Hankel transform.
|
||||
|
||||
Returns an offset close to `initial` that fulfils the low-ringing
|
||||
condition of [1]_ for the fast Hankel transform `fht` with logarithmic
|
||||
spacing `dln`, order `mu` and bias `bias`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
dln : float
|
||||
Uniform logarithmic spacing of the transform.
|
||||
mu : float
|
||||
Order of the Hankel transform, any positive or negative real number.
|
||||
initial : float, optional
|
||||
Initial value for the offset. Returns the closest value that fulfils
|
||||
the low-ringing condition.
|
||||
bias : float, optional
|
||||
Exponent of power law bias, any positive or negative real number.
|
||||
|
||||
Returns
|
||||
-------
|
||||
offset : float
|
||||
Optimal offset of the uniform logarithmic spacing of the transform that
|
||||
fulfils a low-ringing condition.
|
||||
|
||||
See also
|
||||
--------
|
||||
fht : Definition of the fast Hankel transform.
|
||||
|
||||
References
|
||||
----------
|
||||
.. [1] Hamilton A. J. S., 2000, MNRAS, 312, 257 (astro-ph/9905191)
|
||||
|
||||
'''
|
||||
|
||||
lnkr, q = initial, bias
|
||||
|
||||
xp = (mu+1+q)/2
|
||||
xm = (mu+1-q)/2
|
||||
y = np.pi/(2*dln)
|
||||
zp = loggamma(xp + 1j*y)
|
||||
zm = loggamma(xm + 1j*y)
|
||||
arg = (LN_2 - lnkr)/dln + (zp.imag + zm.imag)/np.pi
|
||||
return lnkr + (arg - np.round(arg))*dln
|
||||
|
||||
|
||||
def _fhtq(a, u, inverse=False):
|
||||
'''Compute the biased fast Hankel transform.
|
||||
|
||||
This is the basic FFTLog routine.
|
||||
'''
|
||||
|
||||
# size of transform
|
||||
n = np.shape(a)[-1]
|
||||
|
||||
# check for singular transform or singular inverse transform
|
||||
if np.isinf(u[0]) and not inverse:
|
||||
warn(f'singular transform; consider changing the bias')
|
||||
# fix coefficient to obtain (potentially correct) transform anyway
|
||||
u = u.copy()
|
||||
u[0] = 0
|
||||
elif u[0] == 0 and inverse:
|
||||
warn(f'singular inverse transform; consider changing the bias')
|
||||
# fix coefficient to obtain (potentially correct) inverse anyway
|
||||
u = u.copy()
|
||||
u[0] = np.inf
|
||||
|
||||
# biased fast Hankel transform via real FFT
|
||||
A = rfft(a, axis=-1)
|
||||
if not inverse:
|
||||
# forward transform
|
||||
A *= u
|
||||
else:
|
||||
# backward transform
|
||||
A /= u.conj()
|
||||
A = irfft(A, n, axis=-1)
|
||||
A = A[..., ::-1]
|
||||
|
||||
return A
|
||||
Vendored
-100
@@ -1,100 +0,0 @@
|
||||
from functools import update_wrapper, lru_cache
|
||||
|
||||
from ._pocketfft import helper as _helper
|
||||
|
||||
|
||||
def next_fast_len(target, real=False):
|
||||
"""Find the next fast size of input data to ``fft``, for zero-padding, etc.
|
||||
|
||||
SciPy's FFT algorithms gain their speed by a recursive divide and conquer
|
||||
strategy. This relies on efficient functions for small prime factors of the
|
||||
input length. Thus, the transforms are fastest when using composites of the
|
||||
prime factors handled by the fft implementation. If there are efficient
|
||||
functions for all radices <= `n`, then the result will be a number `x`
|
||||
>= ``target`` with only prime factors < `n`. (Also known as `n`-smooth
|
||||
numbers)
|
||||
|
||||
Parameters
|
||||
----------
|
||||
target : int
|
||||
Length to start searching from. Must be a positive integer.
|
||||
real : bool, optional
|
||||
True if the FFT involves real input or output (e.g., `rfft` or `hfft`
|
||||
but not `fft`). Defaults to False.
|
||||
|
||||
Returns
|
||||
-------
|
||||
out : int
|
||||
The smallest fast length greater than or equal to ``target``.
|
||||
|
||||
Notes
|
||||
-----
|
||||
The result of this function may change in future as performance
|
||||
considerations change, for example, if new prime factors are added.
|
||||
|
||||
Calling `fft` or `ifft` with real input data performs an ``'R2C'``
|
||||
transform internally.
|
||||
|
||||
Examples
|
||||
--------
|
||||
On a particular machine, an FFT of prime length takes 11.4 ms:
|
||||
|
||||
>>> from scipy import fft
|
||||
>>> rng = np.random.default_rng()
|
||||
>>> min_len = 93059 # prime length is worst case for speed
|
||||
>>> a = rng.standard_normal(min_len)
|
||||
>>> b = fft.fft(a)
|
||||
|
||||
Zero-padding to the next regular length reduces computation time to
|
||||
1.6 ms, a speedup of 7.3 times:
|
||||
|
||||
>>> fft.next_fast_len(min_len, real=True)
|
||||
93312
|
||||
>>> b = fft.fft(a, 93312)
|
||||
|
||||
Rounding up to the next power of 2 is not optimal, taking 3.0 ms to
|
||||
compute; 1.9 times longer than the size given by ``next_fast_len``:
|
||||
|
||||
>>> b = fft.fft(a, 131072)
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
# Directly wrap the c-function good_size but take the docstring etc., from the
|
||||
# next_fast_len function above
|
||||
next_fast_len = update_wrapper(lru_cache()(_helper.good_size), next_fast_len)
|
||||
next_fast_len.__wrapped__ = _helper.good_size
|
||||
|
||||
|
||||
def _init_nd_shape_and_axes(x, shape, axes):
|
||||
"""Handle shape and axes arguments for N-D transforms.
|
||||
|
||||
Returns the shape and axes in a standard form, taking into account negative
|
||||
values and checking for various potential errors.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x : array_like
|
||||
The input array.
|
||||
shape : int or array_like of ints or None
|
||||
The shape of the result. If both `shape` and `axes` (see below) are
|
||||
None, `shape` is ``x.shape``; if `shape` is None but `axes` is
|
||||
not None, then `shape` is ``numpy.take(x.shape, axes, axis=0)``.
|
||||
If `shape` is -1, the size of the corresponding dimension of `x` is
|
||||
used.
|
||||
axes : int or array_like of ints or None
|
||||
Axes along which the calculation is computed.
|
||||
The default is over all axes.
|
||||
Negative indices are automatically converted to their positive
|
||||
counterparts.
|
||||
|
||||
Returns
|
||||
-------
|
||||
shape : array
|
||||
The shape of the result. It is a 1-D integer array.
|
||||
axes : array
|
||||
The shape of the result. It is a 1-D integer array.
|
||||
|
||||
"""
|
||||
return _helper._init_nd_shape_and_axes(x, shape, axes)
|
||||
-25
@@ -1,25 +0,0 @@
|
||||
Copyright (C) 2010-2019 Max-Planck-Society
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright notice, this
|
||||
list of conditions and the following disclaimer in the documentation and/or
|
||||
other materials provided with the distribution.
|
||||
* Neither the name of the copyright holder nor the names of its contributors may
|
||||
be used to endorse or promote products derived from this software without
|
||||
specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
@@ -1,9 +0,0 @@
|
||||
""" FFT backend using pypocketfft """
|
||||
|
||||
from .basic import *
|
||||
from .realtransforms import *
|
||||
from .helper import *
|
||||
|
||||
from scipy._lib._testutils import PytestTester
|
||||
test = PytestTester(__name__)
|
||||
del PytestTester
|
||||
-297
@@ -1,297 +0,0 @@
|
||||
"""
|
||||
Discrete Fourier Transforms - basic.py
|
||||
"""
|
||||
import numpy as np
|
||||
import functools
|
||||
from . import pypocketfft as pfft
|
||||
from .helper import (_asfarray, _init_nd_shape_and_axes, _datacopied,
|
||||
_fix_shape, _fix_shape_1d, _normalization,
|
||||
_workers)
|
||||
|
||||
def c2c(forward, x, n=None, axis=-1, norm=None, overwrite_x=False,
|
||||
workers=None, *, plan=None):
|
||||
""" Return discrete Fourier transform of real or complex sequence. """
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
tmp = _asfarray(x)
|
||||
overwrite_x = overwrite_x or _datacopied(tmp, x)
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(workers)
|
||||
|
||||
if n is not None:
|
||||
tmp, copied = _fix_shape_1d(tmp, n, axis)
|
||||
overwrite_x = overwrite_x or copied
|
||||
elif tmp.shape[axis] < 1:
|
||||
raise ValueError("invalid number of data points ({0}) specified"
|
||||
.format(tmp.shape[axis]))
|
||||
|
||||
out = (tmp if overwrite_x and tmp.dtype.kind == 'c' else None)
|
||||
|
||||
return pfft.c2c(tmp, (axis,), forward, norm, out, workers)
|
||||
|
||||
|
||||
fft = functools.partial(c2c, True)
|
||||
fft.__name__ = 'fft'
|
||||
ifft = functools.partial(c2c, False)
|
||||
ifft.__name__ = 'ifft'
|
||||
|
||||
|
||||
def r2c(forward, x, n=None, axis=-1, norm=None, overwrite_x=False,
|
||||
workers=None, *, plan=None):
|
||||
"""
|
||||
Discrete Fourier transform of a real sequence.
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
tmp = _asfarray(x)
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(workers)
|
||||
|
||||
if not np.isrealobj(tmp):
|
||||
raise TypeError("x must be a real sequence")
|
||||
|
||||
if n is not None:
|
||||
tmp, _ = _fix_shape_1d(tmp, n, axis)
|
||||
elif tmp.shape[axis] < 1:
|
||||
raise ValueError("invalid number of data points ({0}) specified"
|
||||
.format(tmp.shape[axis]))
|
||||
|
||||
# Note: overwrite_x is not utilised
|
||||
return pfft.r2c(tmp, (axis,), forward, norm, None, workers)
|
||||
|
||||
|
||||
rfft = functools.partial(r2c, True)
|
||||
rfft.__name__ = 'rfft'
|
||||
ihfft = functools.partial(r2c, False)
|
||||
ihfft.__name__ = 'ihfft'
|
||||
|
||||
|
||||
def c2r(forward, x, n=None, axis=-1, norm=None, overwrite_x=False,
|
||||
workers=None, *, plan=None):
|
||||
"""
|
||||
Return inverse discrete Fourier transform of real sequence x.
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
tmp = _asfarray(x)
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(workers)
|
||||
|
||||
# TODO: Optimize for hermitian and real?
|
||||
if np.isrealobj(tmp):
|
||||
tmp = tmp + 0.j
|
||||
|
||||
# Last axis utilizes hermitian symmetry
|
||||
if n is None:
|
||||
n = (tmp.shape[axis] - 1) * 2
|
||||
if n < 1:
|
||||
raise ValueError("Invalid number of data points ({0}) specified"
|
||||
.format(n))
|
||||
else:
|
||||
tmp, _ = _fix_shape_1d(tmp, (n//2) + 1, axis)
|
||||
|
||||
# Note: overwrite_x is not utilized
|
||||
return pfft.c2r(tmp, (axis,), n, forward, norm, None, workers)
|
||||
|
||||
|
||||
hfft = functools.partial(c2r, True)
|
||||
hfft.__name__ = 'hfft'
|
||||
irfft = functools.partial(c2r, False)
|
||||
irfft.__name__ = 'irfft'
|
||||
|
||||
|
||||
def fft2(x, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None,
|
||||
*, plan=None):
|
||||
"""
|
||||
2-D discrete Fourier transform.
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
return fftn(x, s, axes, norm, overwrite_x, workers)
|
||||
|
||||
|
||||
def ifft2(x, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None,
|
||||
*, plan=None):
|
||||
"""
|
||||
2-D discrete inverse Fourier transform of real or complex sequence.
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
return ifftn(x, s, axes, norm, overwrite_x, workers)
|
||||
|
||||
|
||||
def rfft2(x, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None,
|
||||
*, plan=None):
|
||||
"""
|
||||
2-D discrete Fourier transform of a real sequence
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
return rfftn(x, s, axes, norm, overwrite_x, workers)
|
||||
|
||||
|
||||
def irfft2(x, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None,
|
||||
*, plan=None):
|
||||
"""
|
||||
2-D discrete inverse Fourier transform of a real sequence
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
return irfftn(x, s, axes, norm, overwrite_x, workers)
|
||||
|
||||
|
||||
def hfft2(x, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None,
|
||||
*, plan=None):
|
||||
"""
|
||||
2-D discrete Fourier transform of a Hermitian sequence
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
return hfftn(x, s, axes, norm, overwrite_x, workers)
|
||||
|
||||
|
||||
def ihfft2(x, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None,
|
||||
*, plan=None):
|
||||
"""
|
||||
2-D discrete inverse Fourier transform of a Hermitian sequence
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
return ihfftn(x, s, axes, norm, overwrite_x, workers)
|
||||
|
||||
|
||||
def c2cn(forward, x, s=None, axes=None, norm=None, overwrite_x=False,
|
||||
workers=None, *, plan=None):
|
||||
"""
|
||||
Return multidimensional discrete Fourier transform.
|
||||
"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
tmp = _asfarray(x)
|
||||
|
||||
shape, axes = _init_nd_shape_and_axes(tmp, s, axes)
|
||||
overwrite_x = overwrite_x or _datacopied(tmp, x)
|
||||
workers = _workers(workers)
|
||||
|
||||
if len(axes) == 0:
|
||||
return x
|
||||
|
||||
tmp, copied = _fix_shape(tmp, shape, axes)
|
||||
overwrite_x = overwrite_x or copied
|
||||
|
||||
norm = _normalization(norm, forward)
|
||||
out = (tmp if overwrite_x and tmp.dtype.kind == 'c' else None)
|
||||
|
||||
return pfft.c2c(tmp, axes, forward, norm, out, workers)
|
||||
|
||||
|
||||
fftn = functools.partial(c2cn, True)
|
||||
fftn.__name__ = 'fftn'
|
||||
ifftn = functools.partial(c2cn, False)
|
||||
ifftn.__name__ = 'ifftn'
|
||||
|
||||
def r2cn(forward, x, s=None, axes=None, norm=None, overwrite_x=False,
|
||||
workers=None, *, plan=None):
|
||||
"""Return multidimensional discrete Fourier transform of real input"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
tmp = _asfarray(x)
|
||||
|
||||
if not np.isrealobj(tmp):
|
||||
raise TypeError("x must be a real sequence")
|
||||
|
||||
shape, axes = _init_nd_shape_and_axes(tmp, s, axes)
|
||||
tmp, _ = _fix_shape(tmp, shape, axes)
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(workers)
|
||||
|
||||
if len(axes) == 0:
|
||||
raise ValueError("at least 1 axis must be transformed")
|
||||
|
||||
# Note: overwrite_x is not utilized
|
||||
return pfft.r2c(tmp, axes, forward, norm, None, workers)
|
||||
|
||||
|
||||
rfftn = functools.partial(r2cn, True)
|
||||
rfftn.__name__ = 'rfftn'
|
||||
ihfftn = functools.partial(r2cn, False)
|
||||
ihfftn.__name__ = 'ihfftn'
|
||||
|
||||
|
||||
def c2rn(forward, x, s=None, axes=None, norm=None, overwrite_x=False,
|
||||
workers=None, *, plan=None):
|
||||
"""Multidimensional inverse discrete fourier transform with real output"""
|
||||
if plan is not None:
|
||||
raise NotImplementedError('Passing a precomputed plan is not yet '
|
||||
'supported by scipy.fft functions')
|
||||
tmp = _asfarray(x)
|
||||
|
||||
# TODO: Optimize for hermitian and real?
|
||||
if np.isrealobj(tmp):
|
||||
tmp = tmp + 0.j
|
||||
|
||||
noshape = s is None
|
||||
shape, axes = _init_nd_shape_and_axes(tmp, s, axes)
|
||||
|
||||
if len(axes) == 0:
|
||||
raise ValueError("at least 1 axis must be transformed")
|
||||
|
||||
if noshape:
|
||||
shape[-1] = (x.shape[axes[-1]] - 1) * 2
|
||||
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(workers)
|
||||
|
||||
# Last axis utilizes hermitian symmetry
|
||||
lastsize = shape[-1]
|
||||
shape[-1] = (shape[-1] // 2) + 1
|
||||
|
||||
tmp, _ = _fix_shape(tmp, shape, axes)
|
||||
|
||||
# Note: overwrite_x is not utilized
|
||||
return pfft.c2r(tmp, axes, lastsize, forward, norm, None, workers)
|
||||
|
||||
|
||||
hfftn = functools.partial(c2rn, True)
|
||||
hfftn.__name__ = 'hfftn'
|
||||
irfftn = functools.partial(c2rn, False)
|
||||
irfftn.__name__ = 'irfftn'
|
||||
|
||||
|
||||
def r2r_fftpack(forward, x, n=None, axis=-1, norm=None, overwrite_x=False):
|
||||
"""FFT of a real sequence, returning fftpack half complex format"""
|
||||
tmp = _asfarray(x)
|
||||
overwrite_x = overwrite_x or _datacopied(tmp, x)
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(None)
|
||||
|
||||
if tmp.dtype.kind == 'c':
|
||||
raise TypeError('x must be a real sequence')
|
||||
|
||||
if n is not None:
|
||||
tmp, copied = _fix_shape_1d(tmp, n, axis)
|
||||
overwrite_x = overwrite_x or copied
|
||||
elif tmp.shape[axis] < 1:
|
||||
raise ValueError("invalid number of data points ({0}) specified"
|
||||
.format(tmp.shape[axis]))
|
||||
|
||||
out = (tmp if overwrite_x else None)
|
||||
|
||||
return pfft.r2r_fftpack(tmp, (axis,), forward, forward, norm, out, workers)
|
||||
|
||||
|
||||
rfft_fftpack = functools.partial(r2r_fftpack, True)
|
||||
rfft_fftpack.__name__ = 'rfft_fftpack'
|
||||
irfft_fftpack = functools.partial(r2r_fftpack, False)
|
||||
irfft_fftpack.__name__ = 'irfft_fftpack'
|
||||
-215
@@ -1,215 +0,0 @@
|
||||
from numbers import Number
|
||||
import operator
|
||||
import os
|
||||
import threading
|
||||
import contextlib
|
||||
|
||||
import numpy as np
|
||||
# good_size is exposed (and used) from this import
|
||||
from .pypocketfft import good_size
|
||||
|
||||
_config = threading.local()
|
||||
_cpu_count = os.cpu_count()
|
||||
|
||||
|
||||
def _iterable_of_int(x, name=None):
|
||||
"""Convert ``x`` to an iterable sequence of int
|
||||
|
||||
Parameters
|
||||
----------
|
||||
x : value, or sequence of values, convertible to int
|
||||
name : str, optional
|
||||
Name of the argument being converted, only used in the error message
|
||||
|
||||
Returns
|
||||
-------
|
||||
y : ``List[int]``
|
||||
"""
|
||||
if isinstance(x, Number):
|
||||
x = (x,)
|
||||
|
||||
try:
|
||||
x = [operator.index(a) for a in x]
|
||||
except TypeError as e:
|
||||
name = name or "value"
|
||||
raise ValueError("{} must be a scalar or iterable of integers"
|
||||
.format(name)) from e
|
||||
|
||||
return x
|
||||
|
||||
|
||||
def _init_nd_shape_and_axes(x, shape, axes):
|
||||
"""Handles shape and axes arguments for nd transforms"""
|
||||
noshape = shape is None
|
||||
noaxes = axes is None
|
||||
|
||||
if not noaxes:
|
||||
axes = _iterable_of_int(axes, 'axes')
|
||||
axes = [a + x.ndim if a < 0 else a for a in axes]
|
||||
|
||||
if any(a >= x.ndim or a < 0 for a in axes):
|
||||
raise ValueError("axes exceeds dimensionality of input")
|
||||
if len(set(axes)) != len(axes):
|
||||
raise ValueError("all axes must be unique")
|
||||
|
||||
if not noshape:
|
||||
shape = _iterable_of_int(shape, 'shape')
|
||||
|
||||
if axes and len(axes) != len(shape):
|
||||
raise ValueError("when given, axes and shape arguments"
|
||||
" have to be of the same length")
|
||||
if noaxes:
|
||||
if len(shape) > x.ndim:
|
||||
raise ValueError("shape requires more axes than are present")
|
||||
axes = range(x.ndim - len(shape), x.ndim)
|
||||
|
||||
shape = [x.shape[a] if s == -1 else s for s, a in zip(shape, axes)]
|
||||
elif noaxes:
|
||||
shape = list(x.shape)
|
||||
axes = range(x.ndim)
|
||||
else:
|
||||
shape = [x.shape[a] for a in axes]
|
||||
|
||||
if any(s < 1 for s in shape):
|
||||
raise ValueError(
|
||||
"invalid number of data points ({0}) specified".format(shape))
|
||||
|
||||
return shape, axes
|
||||
|
||||
|
||||
def _asfarray(x):
|
||||
"""
|
||||
Convert to array with floating or complex dtype.
|
||||
|
||||
float16 values are also promoted to float32.
|
||||
"""
|
||||
if not hasattr(x, "dtype"):
|
||||
x = np.asarray(x)
|
||||
|
||||
if x.dtype == np.float16:
|
||||
return np.asarray(x, np.float32)
|
||||
elif x.dtype.kind not in 'fc':
|
||||
return np.asarray(x, np.float64)
|
||||
|
||||
# Require native byte order
|
||||
dtype = x.dtype.newbyteorder('=')
|
||||
# Always align input
|
||||
copy = not x.flags['ALIGNED']
|
||||
return np.array(x, dtype=dtype, copy=copy)
|
||||
|
||||
def _datacopied(arr, original):
|
||||
"""
|
||||
Strict check for `arr` not sharing any data with `original`,
|
||||
under the assumption that arr = asarray(original)
|
||||
"""
|
||||
if arr is original:
|
||||
return False
|
||||
if not isinstance(original, np.ndarray) and hasattr(original, '__array__'):
|
||||
return False
|
||||
return arr.base is None
|
||||
|
||||
|
||||
def _fix_shape(x, shape, axes):
|
||||
"""Internal auxiliary function for _raw_fft, _raw_fftnd."""
|
||||
must_copy = False
|
||||
|
||||
# Build an nd slice with the dimensions to be read from x
|
||||
index = [slice(None)]*x.ndim
|
||||
for n, ax in zip(shape, axes):
|
||||
if x.shape[ax] >= n:
|
||||
index[ax] = slice(0, n)
|
||||
else:
|
||||
index[ax] = slice(0, x.shape[ax])
|
||||
must_copy = True
|
||||
|
||||
index = tuple(index)
|
||||
|
||||
if not must_copy:
|
||||
return x[index], False
|
||||
|
||||
s = list(x.shape)
|
||||
for n, axis in zip(shape, axes):
|
||||
s[axis] = n
|
||||
|
||||
z = np.zeros(s, x.dtype)
|
||||
z[index] = x[index]
|
||||
return z, True
|
||||
|
||||
|
||||
def _fix_shape_1d(x, n, axis):
|
||||
if n < 1:
|
||||
raise ValueError(
|
||||
"invalid number of data points ({0}) specified".format(n))
|
||||
|
||||
return _fix_shape(x, (n,), (axis,))
|
||||
|
||||
|
||||
_NORM_MAP = {None: 0, 'backward': 0, 'ortho': 1, 'forward': 2}
|
||||
|
||||
|
||||
def _normalization(norm, forward):
|
||||
"""Returns the pypocketfft normalization mode from the norm argument"""
|
||||
try:
|
||||
inorm = _NORM_MAP[norm]
|
||||
return inorm if forward else (2 - inorm)
|
||||
except KeyError:
|
||||
raise ValueError(
|
||||
f'Invalid norm value {norm!r}, should '
|
||||
'be "backward", "ortho" or "forward"') from None
|
||||
|
||||
|
||||
def _workers(workers):
|
||||
if workers is None:
|
||||
return getattr(_config, 'default_workers', 1)
|
||||
|
||||
if workers < 0:
|
||||
if workers >= -_cpu_count:
|
||||
workers += 1 + _cpu_count
|
||||
else:
|
||||
raise ValueError("workers value out of range; got {}, must not be"
|
||||
" less than {}".format(workers, -_cpu_count))
|
||||
elif workers == 0:
|
||||
raise ValueError("workers must not be zero")
|
||||
|
||||
return workers
|
||||
|
||||
|
||||
@contextlib.contextmanager
|
||||
def set_workers(workers):
|
||||
"""Context manager for the default number of workers used in `scipy.fft`
|
||||
|
||||
Parameters
|
||||
----------
|
||||
workers : int
|
||||
The default number of workers to use
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy import fft, signal
|
||||
>>> rng = np.random.default_rng()
|
||||
>>> x = rng.standard_normal((128, 64))
|
||||
>>> with fft.set_workers(4):
|
||||
... y = signal.fftconvolve(x, x)
|
||||
|
||||
"""
|
||||
old_workers = get_workers()
|
||||
_config.default_workers = _workers(operator.index(workers))
|
||||
try:
|
||||
yield
|
||||
finally:
|
||||
_config.default_workers = old_workers
|
||||
|
||||
|
||||
def get_workers():
|
||||
"""Returns the default number of workers within the current context
|
||||
|
||||
Examples
|
||||
--------
|
||||
>>> from scipy import fft
|
||||
>>> fft.get_workers()
|
||||
1
|
||||
>>> with fft.set_workers(4):
|
||||
... fft.get_workers()
|
||||
4
|
||||
"""
|
||||
return getattr(_config, 'default_workers', 1)
|
||||
-110
@@ -1,110 +0,0 @@
|
||||
import numpy as np
|
||||
from . import pypocketfft as pfft
|
||||
from .helper import (_asfarray, _init_nd_shape_and_axes, _datacopied,
|
||||
_fix_shape, _fix_shape_1d, _normalization, _workers)
|
||||
import functools
|
||||
|
||||
|
||||
def _r2r(forward, transform, x, type=2, n=None, axis=-1, norm=None,
|
||||
overwrite_x=False, workers=None):
|
||||
"""Forward or backward 1-D DCT/DST
|
||||
|
||||
Parameters
|
||||
----------
|
||||
forward: bool
|
||||
Transform direction (determines type and normalisation)
|
||||
transform: {pypocketfft.dct, pypocketfft.dst}
|
||||
The transform to perform
|
||||
"""
|
||||
tmp = _asfarray(x)
|
||||
overwrite_x = overwrite_x or _datacopied(tmp, x)
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(workers)
|
||||
|
||||
if not forward:
|
||||
if type == 2:
|
||||
type = 3
|
||||
elif type == 3:
|
||||
type = 2
|
||||
|
||||
if n is not None:
|
||||
tmp, copied = _fix_shape_1d(tmp, n, axis)
|
||||
overwrite_x = overwrite_x or copied
|
||||
elif tmp.shape[axis] < 1:
|
||||
raise ValueError("invalid number of data points ({0}) specified"
|
||||
.format(tmp.shape[axis]))
|
||||
|
||||
out = (tmp if overwrite_x else None)
|
||||
|
||||
# For complex input, transform real and imaginary components separably
|
||||
if np.iscomplexobj(x):
|
||||
out = np.empty_like(tmp) if out is None else out
|
||||
transform(tmp.real, type, (axis,), norm, out.real, workers)
|
||||
transform(tmp.imag, type, (axis,), norm, out.imag, workers)
|
||||
return out
|
||||
|
||||
return transform(tmp, type, (axis,), norm, out, workers)
|
||||
|
||||
|
||||
dct = functools.partial(_r2r, True, pfft.dct)
|
||||
dct.__name__ = 'dct'
|
||||
idct = functools.partial(_r2r, False, pfft.dct)
|
||||
idct.__name__ = 'idct'
|
||||
|
||||
dst = functools.partial(_r2r, True, pfft.dst)
|
||||
dst.__name__ = 'dst'
|
||||
idst = functools.partial(_r2r, False, pfft.dst)
|
||||
idst.__name__ = 'idst'
|
||||
|
||||
|
||||
def _r2rn(forward, transform, x, type=2, s=None, axes=None, norm=None,
|
||||
overwrite_x=False, workers=None):
|
||||
"""Forward or backward nd DCT/DST
|
||||
|
||||
Parameters
|
||||
----------
|
||||
forward: bool
|
||||
Transform direction (determines type and normalisation)
|
||||
transform: {pypocketfft.dct, pypocketfft.dst}
|
||||
The transform to perform
|
||||
"""
|
||||
tmp = _asfarray(x)
|
||||
|
||||
shape, axes = _init_nd_shape_and_axes(tmp, s, axes)
|
||||
overwrite_x = overwrite_x or _datacopied(tmp, x)
|
||||
|
||||
if len(axes) == 0:
|
||||
return x
|
||||
|
||||
tmp, copied = _fix_shape(tmp, shape, axes)
|
||||
overwrite_x = overwrite_x or copied
|
||||
|
||||
if not forward:
|
||||
if type == 2:
|
||||
type = 3
|
||||
elif type == 3:
|
||||
type = 2
|
||||
|
||||
norm = _normalization(norm, forward)
|
||||
workers = _workers(workers)
|
||||
out = (tmp if overwrite_x else None)
|
||||
|
||||
# For complex input, transform real and imaginary components separably
|
||||
if np.iscomplexobj(x):
|
||||
out = np.empty_like(tmp) if out is None else out
|
||||
transform(tmp.real, type, axes, norm, out.real, workers)
|
||||
transform(tmp.imag, type, axes, norm, out.imag, workers)
|
||||
return out
|
||||
|
||||
return transform(tmp, type, axes, norm, out, workers)
|
||||
|
||||
|
||||
dctn = functools.partial(_r2rn, True, pfft.dct)
|
||||
dctn.__name__ = 'dctn'
|
||||
idctn = functools.partial(_r2rn, False, pfft.dct)
|
||||
idctn.__name__ = 'idctn'
|
||||
|
||||
dstn = functools.partial(_r2rn, True, pfft.dst)
|
||||
dstn.__name__ = 'dstn'
|
||||
idstn = functools.partial(_r2rn, False, pfft.dst)
|
||||
idstn.__name__ = 'idstn'
|
||||
-49
@@ -1,49 +0,0 @@
|
||||
|
||||
def pre_build_hook(build_ext, ext):
|
||||
from scipy._build_utils.compiler_helper import (
|
||||
set_cxx_flags_hook, try_add_flag, try_compile, has_flag)
|
||||
cc = build_ext._cxx_compiler
|
||||
args = ext.extra_compile_args
|
||||
|
||||
set_cxx_flags_hook(build_ext, ext)
|
||||
|
||||
if cc.compiler_type == 'msvc':
|
||||
args.append('/EHsc')
|
||||
else:
|
||||
# Use pthreads if available
|
||||
has_pthreads = try_compile(cc, code='#include <pthread.h>\n'
|
||||
'int main(int argc, char **argv) {}')
|
||||
if has_pthreads:
|
||||
ext.define_macros.append(('POCKETFFT_PTHREADS', None))
|
||||
if has_flag(cc, '-pthread'):
|
||||
args.append('-pthread')
|
||||
ext.extra_link_args.append('-pthread')
|
||||
else:
|
||||
raise RuntimeError("Build failed: System has pthreads header "
|
||||
"but could not compile with -pthread option")
|
||||
|
||||
# Don't export library symbols
|
||||
try_add_flag(args, cc, '-fvisibility=hidden')
|
||||
|
||||
|
||||
def configuration(parent_package='', top_path=None):
|
||||
from numpy.distutils.misc_util import Configuration
|
||||
import pybind11
|
||||
include_dirs = [pybind11.get_include(True), pybind11.get_include(False)]
|
||||
|
||||
config = Configuration('_pocketfft', parent_package, top_path)
|
||||
ext = config.add_extension('pypocketfft',
|
||||
sources=['pypocketfft.cxx'],
|
||||
depends=['pocketfft_hdronly.h'],
|
||||
include_dirs=include_dirs,
|
||||
language='c++')
|
||||
ext._pre_build_hook = pre_build_hook
|
||||
|
||||
config.add_data_files('LICENSE.md')
|
||||
config.add_data_dir('tests')
|
||||
return config
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
from numpy.distutils.core import setup
|
||||
setup(**configuration(top_path='').todict())
|
||||
-1022
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user