changeset 400:c640f37d1c74 feature/lazy_linear_map

Update documentation
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Mon, 05 Oct 2020 10:34:50 +0200
parents 3b4b1758a8ad
children ab0a57bedaa8
files src/LazyTensors/lazy_tensor_operations.jl
diffstat 1 files changed, 3 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/LazyTensors/lazy_tensor_operations.jl	Sun Oct 04 21:37:00 2020 +0200
+++ b/src/LazyTensors/lazy_tensor_operations.jl	Mon Oct 05 10:34:50 2020 +0200
@@ -104,11 +104,10 @@
     LazyLinearMap{T,R,D,...}(A, range_indicies, domain_indicies)
 
 TensorMapping defined by the AbstractArray A. `range_indicies` and `domain_indicies` define which indicies of A should
-be considerd the range and domain of the TensorMapping.
+be considerd the range and domain of the TensorMapping. Each set of indices must be ordered in ascending order.
 
-When the LazyLinearMap is applied to a vector size domain_size the
-map sums over the dimensions orthogonal to those specified in range_indicies resulting
-in a vector of size range_size.
+For instance, if A is a m x n matrix, and range_size = (1,), domain_size = (2,), then the LazyLinearMap performs the
+standard matrix-vector product on vectors of size n.
 """
 struct LazyLinearMap{T,R,D, RD, AA<:AbstractArray{T,RD}} <: TensorMapping{T,R,D}
     A::AA