Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup code #34

Merged
merged 2 commits into from
Feb 20, 2024
Merged

Cleanup code #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18c0627
Added except/noexcept annotations to cdef functions
oleksandr-pavlyk Feb 12, 2024
204c059
Linter changes, update copyright year
oleksandr-pavlyk Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mkl/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2018-2019, Intel Corporation
# Copyright (c) 2018-2024, Intel Corporation
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
Expand Down
2 changes: 1 addition & 1 deletion mkl/_mkl_service.pxd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2018-2019, Intel Corporation
# Copyright (c) 2018-2024, Intel Corporation
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
Expand Down
82 changes: 41 additions & 41 deletions mkl/_mkl_service.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2018-2019, Intel Corporation
# Copyright (c) 2018-2024, Intel Corporation
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
Expand Down Expand Up @@ -391,33 +391,33 @@ cpdef vml_clear_err_status():
return __vml_clear_err_status()


cdef __mkl_status_to_string(int mkl_status):
cdef str __mkl_status_to_string(int mkl_status) noexcept:
if mkl_status == 1:
return 'success'
else:
return 'error'


cdef int __python_obj_to_int(obj, func_name):
cdef int __python_obj_to_int(obj, func_name) except *:
if not isinstance(obj, numbers.Integral):
raise ValueError("The argument of " + func_name + " is expected to be a positive integer")
cdef int c_int = <int>obj
return c_int


cdef void __check_positive_num_threads(int p, func_name):
cdef void __check_positive_num_threads(int p, func_name) except *:
if p <= 0:
warnings.warn("Non-positive argument of " + func_name +
" is being ignored, number of threads will not be changed")


cdef void __check_non_negative_num_threads(int p, func_name):
cdef void __check_non_negative_num_threads(int p, func_name) except *:
if p < 0:
warnings.warn("Negative argument of " + func_name +
" is being ignored, number of threads will not be changed")


cdef inline int __mkl_str_to_int(variable, possible_variables_dict):
cdef inline int __mkl_str_to_int(variable, possible_variables_dict) except *:
if variable is None:
raise ValueError("Variable can not be None")
if possible_variables_dict is None:
Expand All @@ -429,7 +429,7 @@ cdef inline int __mkl_str_to_int(variable, possible_variables_dict):
return possible_variables_dict[variable]


cdef __mkl_int_to_str(int mkl_int_variable, possible_variables_dict):
cdef __mkl_int_to_str(int mkl_int_variable, possible_variables_dict) except *:
if possible_variables_dict is None:
raise RuntimeError("Dictionary mapping possible internal code to output string is missing")

Expand All @@ -441,7 +441,7 @@ cdef __mkl_int_to_str(int mkl_int_variable, possible_variables_dict):


# Version Information
cdef inline mkl.MKLVersion __get_version():
cdef mkl.MKLVersion __get_version() noexcept:
"""
Returns the Intel(R) MKL version.
"""
Expand All @@ -450,7 +450,7 @@ cdef inline mkl.MKLVersion __get_version():
return c_mkl_version


cdef __get_version_string():
cdef str __get_version_string() except *:
"""
Returns the Intel(R) MKL version in a character string.
"""
Expand All @@ -461,7 +461,7 @@ cdef __get_version_string():


# Threading
cdef inline int __set_num_threads(int num_threads):
cdef inline int __set_num_threads(int num_threads) noexcept:
"""
Specifies the number of OpenMP* threads to use.
"""
Expand All @@ -471,15 +471,15 @@ cdef inline int __set_num_threads(int num_threads):
return prev_num_threads


cdef inline int __domain_set_num_threads(int c_num_threads, int mkl_domain):
cdef inline int __domain_set_num_threads(int c_num_threads, int mkl_domain) noexcept:
"""
Specifies the number of OpenMP* threads for a particular function domain.
"""
cdef int mkl_status = mkl.mkl_domain_set_num_threads(c_num_threads, mkl_domain)
return mkl_status


cdef inline int __set_num_threads_local(int c_num_threads):
cdef inline int __set_num_threads_local(int c_num_threads) noexcept:
"""
Specifies the number of OpenMP* threads for all Intel(R) MKL functions on the current execution thread.
"""
Expand All @@ -488,7 +488,7 @@ cdef inline int __set_num_threads_local(int c_num_threads):
return c_mkl_status


cdef inline int __set_dynamic(int c_enable):
cdef inline int __set_dynamic(int c_enable) noexcept:
"""
Enables Intel(R) MKL to dynamically change the number of OpenMP* threads.
"""
Expand All @@ -497,14 +497,14 @@ cdef inline int __set_dynamic(int c_enable):
return __get_max_threads()


cdef inline int __get_max_threads():
cdef inline int __get_max_threads() noexcept:
"""
Gets the number of OpenMP* threads targeted for parallelism.
"""
return mkl.mkl_get_max_threads()


cdef inline int __domain_get_max_threads(int c_mkl_domain):
cdef inline int __domain_get_max_threads(int c_mkl_domain) noexcept:
"""
Gets the number of OpenMP* threads targeted for parallelism for a particular function domain.
"""
Expand All @@ -513,15 +513,15 @@ cdef inline int __domain_get_max_threads(int c_mkl_domain):
return c_num_threads


cdef inline int __get_dynamic():
cdef inline int __get_dynamic() noexcept:
"""
Determines whether Intel(R) MKL is enabled to dynamically change the number of OpenMP* threads.
"""
return mkl.mkl_get_dynamic()


# Timing
cdef inline float __second():
cdef inline float __second() noexcept:
"""
Returns elapsed time in seconds.
Use to estimate real time between two calls to this function.
Expand All @@ -530,7 +530,7 @@ cdef inline float __second():
return mkl.second()


cdef inline double __dsecnd():
cdef inline double __dsecnd() noexcept:
"""
Returns elapsed time in seconds.
Use to estimate real time between two calls to this function.
Expand All @@ -539,7 +539,7 @@ cdef inline double __dsecnd():
return mkl.dsecnd()


cdef inline mkl.MKL_UINT64 __get_cpu_clocks():
cdef inline mkl.MKL_UINT64 __get_cpu_clocks() noexcept:
"""
Returns elapsed CPU clocks.
"""
Expand All @@ -548,52 +548,52 @@ cdef inline mkl.MKL_UINT64 __get_cpu_clocks():
return clocks


cdef inline double __get_cpu_frequency():
cdef inline double __get_cpu_frequency() noexcept:
"""
Returns the current CPU frequency value in GHz.
"""
return mkl.mkl_get_cpu_frequency()


cdef inline double __get_max_cpu_frequency():
cdef inline double __get_max_cpu_frequency() noexcept:
"""
Returns the maximum CPU frequency value in GHz.
"""
return mkl.mkl_get_max_cpu_frequency()


cdef inline double __get_clocks_frequency():
cdef inline double __get_clocks_frequency() noexcept:
"""
Returns the frequency value in GHz based on constant-rate Time Stamp Counter.
"""
return mkl.mkl_get_clocks_frequency()


# Memory Management. See the Intel(R) MKL Developer Guide for more memory usage information.
cdef inline void __free_buffers():
cdef inline void __free_buffers() noexcept:
"""
Frees unused memory allocated by the Intel(R) MKL Memory Allocator.
"""
mkl.mkl_free_buffers()
return


cdef inline void __thread_free_buffers():
cdef inline void __thread_free_buffers() noexcept:
"""
Frees unused memory allocated by the Intel(R) MKL Memory Allocator in the current thread.
"""
mkl.mkl_thread_free_buffers()
return


cdef inline int __disable_fast_mm():
cdef inline int __disable_fast_mm() noexcept:
"""
Turns off the Intel(R) MKL Memory Allocator for Intel(R) MKL functions to directly use the system malloc/free functions.
"""
return mkl.mkl_disable_fast_mm()


cdef inline MemStatData __mem_stat():
cdef inline MemStatData __mem_stat() noexcept:
"""
Reports the status of the Intel(R) MKL Memory Allocator.
"""
Expand All @@ -602,7 +602,7 @@ cdef inline MemStatData __mem_stat():
return mem_stat_data


cdef object __peak_mem_usage(mem_const):
cdef object __peak_mem_usage(mem_const) except *:
"""
Reports the peak memory allocated by the Intel(R) MKL Memory Allocator.
"""
Expand All @@ -625,7 +625,7 @@ cdef object __peak_mem_usage(mem_const):
return memory_allocator


cdef inline object __set_memory_limit(limit):
cdef inline object __set_memory_limit(limit) except *:
"""
On Linux, sets the limit of memory that Intel(R) MKL can allocate for a specified type of memory.
"""
Expand All @@ -636,7 +636,7 @@ cdef inline object __set_memory_limit(limit):


# Conditional Numerical Reproducibility
cdef object __cbwr_set(branch=None):
cdef object __cbwr_set(branch=None) except *:
"""
Configures the CNR mode of Intel(R) MKL.
"""
Expand Down Expand Up @@ -676,7 +676,7 @@ cdef object __cbwr_set(branch=None):
return status


cdef inline __cbwr_get(cnr_const=None):
cdef inline __cbwr_get(cnr_const=None) except *:
"""
Returns the current CNR settings.
"""
Expand Down Expand Up @@ -714,7 +714,7 @@ cdef inline __cbwr_get(cnr_const=None):
return status


cdef object __cbwr_get_auto_branch():
cdef object __cbwr_get_auto_branch() except *:
"""
Automatically detects the CNR code branch for your platform.
"""
Expand Down Expand Up @@ -749,7 +749,7 @@ cdef object __cbwr_get_auto_branch():


# Miscellaneous
cdef object __enable_instructions(isa=None):
cdef object __enable_instructions(isa=None) except *:
"""
Enables dispatching for new Intel architectures or restricts the set of Intel instruction sets available for dispatching.
"""
Expand All @@ -776,7 +776,7 @@ cdef object __enable_instructions(isa=None):
return __mkl_status_to_string(c_mkl_status)


cdef object __set_env_mode():
cdef object __set_env_mode() except *:
"""
Sets up the mode that ignores environment settings specific to Intel(R) MKL. See mkl_set_env_mode(1).
"""
Expand All @@ -793,7 +793,7 @@ cdef object __set_env_mode():
return status


cdef object __get_env_mode():
cdef object __get_env_mode() except *:
"""
Query the current environment mode. See mkl_set_env_mode(0).
"""
Expand All @@ -809,14 +809,14 @@ cdef object __get_env_mode():
return status


cdef inline int __verbose(int c_enable):
cdef inline int __verbose(int c_enable) noexcept:
"""
Enables or disables Intel(R) MKL Verbose mode.
"""
return mkl.mkl_verbose(c_enable)


cdef __set_mpi(vendor, custom_library_name=None):
cdef __set_mpi(vendor, custom_library_name=None) except *:
"""
Sets the implementation of the message-passing interface to be used by Intel(R) MKL.
"""
Expand Down Expand Up @@ -854,7 +854,7 @@ cdef __set_mpi(vendor, custom_library_name=None):


# VM Service Functions
cdef object __vml_set_mode(accuracy, ftzdaz, errmode):
cdef object __vml_set_mode(accuracy, ftzdaz, errmode) except *:
"""
Sets a new mode for VM functions according to the mode parameter and stores the previous VM mode to oldmode.
"""
Expand Down Expand Up @@ -919,7 +919,7 @@ cdef object __vml_set_mode(accuracy, ftzdaz, errmode):
return (accuracy, ftzdaz, errmode)


cdef object __vml_get_mode():
cdef object __vml_get_mode() except *:
"""
Gets the VM mode.
"""
Expand Down Expand Up @@ -972,7 +972,7 @@ __mkl_vml_status = {
}


cdef object __vml_set_err_status(status):
cdef object __vml_set_err_status(status) except *:
"""
Sets the new VM Error Status according to err and stores the previous VM Error Status to olderr.
"""
Expand Down Expand Up @@ -1006,7 +1006,7 @@ cdef object __vml_set_err_status(status):
return status


cdef object __vml_get_err_status():
cdef object __vml_get_err_status() except *:
"""
Gets the VM Error Status.
"""
Expand All @@ -1030,7 +1030,7 @@ cdef object __vml_get_err_status():
return status


cdef object __vml_clear_err_status():
cdef object __vml_clear_err_status() except *:
"""
Sets the VM Error Status to VML_STATUS_OK and stores the previous VM Error Status to olderr.
"""
Expand Down
Loading
Loading