Mercurial > repos > public > sbplib_julia
comparison src/LazyTensors/lazy_tensor_operations.jl @ 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 | 1936e38fe51e |
comparison
equal
deleted
inserted
replaced
399:3b4b1758a8ad | 400:c640f37d1c74 |
---|---|
102 # export → | 102 # export → |
103 """ | 103 """ |
104 LazyLinearMap{T,R,D,...}(A, range_indicies, domain_indicies) | 104 LazyLinearMap{T,R,D,...}(A, range_indicies, domain_indicies) |
105 | 105 |
106 TensorMapping defined by the AbstractArray A. `range_indicies` and `domain_indicies` define which indicies of A should | 106 TensorMapping defined by the AbstractArray A. `range_indicies` and `domain_indicies` define which indicies of A should |
107 be considerd the range and domain of the TensorMapping. | 107 be considerd the range and domain of the TensorMapping. Each set of indices must be ordered in ascending order. |
108 | 108 |
109 When the LazyLinearMap is applied to a vector size domain_size the | 109 For instance, if A is a m x n matrix, and range_size = (1,), domain_size = (2,), then the LazyLinearMap performs the |
110 map sums over the dimensions orthogonal to those specified in range_indicies resulting | 110 standard matrix-vector product on vectors of size n. |
111 in a vector of size range_size. | |
112 """ | 111 """ |
113 struct LazyLinearMap{T,R,D, RD, AA<:AbstractArray{T,RD}} <: TensorMapping{T,R,D} | 112 struct LazyLinearMap{T,R,D, RD, AA<:AbstractArray{T,RD}} <: TensorMapping{T,R,D} |
114 A::AA | 113 A::AA |
115 range_indicies::NTuple{R,Int} | 114 range_indicies::NTuple{R,Int} |
116 domain_indicies::NTuple{D,Int} | 115 domain_indicies::NTuple{D,Int} |