changeset 1840:cb3a8450ed44 refactor/lazy_tensors/elementwise_ops

Add some docstring
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 10 Jan 2025 19:45:11 +0100
parents e1077273eda5
children 21e5fe1545c0
files src/LazyTensors/lazy_tensor_operations.jl
diffstat 1 files changed, 11 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/LazyTensors/lazy_tensor_operations.jl	Thu Jan 09 22:12:26 2025 +0100
+++ b/src/LazyTensors/lazy_tensor_operations.jl	Fri Jan 10 19:45:11 2025 +0100
@@ -51,7 +51,13 @@
 range_size(tmt::TensorTranspose) = domain_size(tmt.tm)
 domain_size(tmt::TensorTranspose) = range_size(tmt.tm)
 
-struct TensorNegation{T,R,D, TM<:LazyTensor{T,R,D}} <: LazyTensor{T,R,D}
+
+"""
+    TensorNegation{T,R,D,...} <: LazyTensor{T,R,D}
+
+The negation of a LazyTensor.
+"""
+struct TensorNegation{T,R,D,TM<:LazyTensor{T,R,D}} <: LazyTensor{T,R,D}
     tm::TM
 end
 
@@ -61,7 +67,11 @@
 range_size(tm::TensorNegation) = range_size(tm.tm)
 domain_size(tm::TensorNegation) = domain_size(tm.tm)
 
+"""
+    TensorSum{T,R,D,...} <: LazyTensor{T,R,D}
 
+The sum of 2 or more lazy tensors.
+"""
 struct TensorSum{T,R,D,TT<:NTuple{N, LazyTensor{T,R,D}} where N} <: LazyTensor{T,R,D}
     tms::TT