Einsums Core Module#
This module contains many functions and classes implemented in C++.
- einsums.core.gpu_enabled() bool #
Check whether
einsums
was built with GPU acceleration enabled.- Returns:
True
if GPU capabilities are enabled.
- einsums.core.initialize()#
Initialize the Einsums library. It does not need to be called directly, and instead it is called when you import
einsums
.
- einsums.core.finalize(arg: bool | str)#
Finalize the Einsums library, optionally printing timing info. See
einsums.set_finalize_arg()
to change how the module calls this function. This does not need to be called directly, as it is registered with theatexit
module.
- einsums.core.report([output_file: str])#
Print the timing report to standard output. If an output file is provided, print to that file instead.
- Parameters:
output_file – The file to optionally print to.
- einsums.core.get_buffer_format(buffer) str #
Get the format string for a buffer as seen from C++.
- Parameters:
buffer – The buffer object to query.
- Einsums Python Tensor Algebra
- Einsums Python GPU Views
- Einsums Python Runtime Tensors
RuntimeTensor
RuntimeTensorX
RuntimeTensorX.__init__()
RuntimeTensorX.zero()
RuntimeTensorX.set_all()
RuntimeTensorX.__getitem__()
RuntimeTensorX.__setitem__()
RuntimeTensorX.__imul__()
RuntimeTensorX.__itruediv__()
RuntimeTensorX.__iadd__()
RuntimeTensorX.__isub__()
RuntimeTensorX.assign()
RuntimeTensorX.dim()
RuntimeTensorX.dims()
RuntimeTensorX.stride()
RuntimeTensorX.strides()
RuntimeTensorX.to_rank_1_view()
RuntimeTensorX.get_name()
RuntimeTensorX.set_name()
RuntimeTensorX.name
RuntimeTensorX.size()
RuntimeTensorX.__len__()
RuntimeTensorX.__iter__()
RuntimeTensorX.__reversed__()
RuntimeTensorX.rank()
RuntimeTensorX.__copy__()
RuntimeTensorX.__deepcopy__()
RuntimeTensorX.copy()
RuntimeTensorX.deepcopy()
RuntimeTensorX.__str__()
- Einsums Python Runtime Tensor Views
RuntimeTensorView
RuntimeTensorViewX
RuntimeTensorViewX.__init__()
RuntimeTensorViewX.zero()
RuntimeTensorViewX.set_all()
RuntimeTensorViewX.__getitem__()
RuntimeTensorViewX.__setitem__()
RuntimeTensorViewX.__imul__()
RuntimeTensorViewX.__itruediv__()
RuntimeTensorViewX.__iadd__()
RuntimeTensorViewX.__isub__()
RuntimeTensorViewX.assign()
RuntimeTensorViewX.dim()
RuntimeTensorViewX.dims()
RuntimeTensorViewX.stride()
RuntimeTensorViewX.strides()
RuntimeTensorViewX.get_name()
RuntimeTensorViewX.set_name()
RuntimeTensorViewX.name
RuntimeTensorViewX.size()
RuntimeTensorViewX.__len__()
RuntimeTensorViewX.__iter__()
RuntimeTensorViewX.__reversed__()
RuntimeTensorViewX.rank()
RuntimeTensorViewX.__copy__()
RuntimeTensorViewX.__deepcopy__()
RuntimeTensorViewX.copy()
RuntimeTensorViewX.deepcopy()
RuntimeTensorViewX.__str__()
- Einsums Python Testing Utilities
BadBuffer
BadBuffer.__init__()
BadBuffer.get_ptr()
BadBuffer.clear_ptr()
BadBuffer.get_ndim()
BadBuffer.set_ndim()
BadBuffer.set_ndim_noresize()
BadBuffer.get_itemsize()
BadBuffer.set_itemszie()
BadBuffer.get_format()
BadBuffer.set_format()
BadBuffer.get_dims()
BadBuffer.set_dims()
BadBuffer.set_dim()
BadBuffer.get_strides()
BadBuffer.set_strides()
BadBuffer.set_stride()
BadBuffer.change_dims_size()
BadBuffer.change_strides_size()
throw_hip()
throw_hipblas()
throw_hipsolver()
- Runtime Tensor Iterators