Coverage for src/beamme/geometric_search/cython.py: 82%

1# The MIT License (MIT) 

2# 

3# Copyright (c) 2018-2026 BeamMe Authors 

4# 

5# Permission is hereby granted, free of charge, to any person obtaining a copy 

6# of this software and associated documentation files (the "Software"), to deal 

7# in the Software without restriction, including without limitation the rights 

8# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 

9# copies of the Software, and to permit persons to whom the Software is 

10# furnished to do so, subject to the following conditions: 

11# 

12# The above copyright notice and this permission notice shall be included in 

13# all copies or substantial portions of the Software. 

14# 

15# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 

16# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 

17# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 

18# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 

19# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 

20# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 

21# THE SOFTWARE. 

22"""This file defines the interface to the Cython geometric search functionality.""" 

23 

24import warnings as _warnings 

25 

26from beamme.geometric_search.utils import cython_is_available as _cython_is_available 

27 

28if _cython_is_available(): 

29 from beamme.geometric_search.cython_lib import ( 

30 find_close_points as _find_close_points, 

31 ) 

32 

33 

34def find_close_points_brute_force_cython( 

35 point_coordinates, tol, *, n_points_performance_warning=5000 

36): 

37 """Call the Cython brute force implementation of find close_points.""" 

38 if _cython_is_available(): 

39 n_points = len(point_coordinates) 

40 if n_points > n_points_performance_warning: 

41 _warnings.warn( 

42 "The function find_close_points is called with the brute force algorithm " 

43 + f"with {n_points} points, for performance reasons other algorithms should be used!" 

44 ) 

45 return _find_close_points(point_coordinates, tol) 

46 else: 

47 raise ModuleNotFoundError( 

48 "Cython geometric search functionality is not available" 

49 )