diff src/LazyTensors/lazy_tensor_operations.jl @ 459:11e58c49fb46 feature/inflated_tensormapping

Add some documentation
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 21 Oct 2020 21:30:18 +0200
parents 41f9cb6ee5a7
children acffa3a1395d
line wrap: on
line diff
--- a/src/LazyTensors/lazy_tensor_operations.jl	Wed Oct 21 20:57:38 2020 +0200
+++ b/src/LazyTensors/lazy_tensor_operations.jl	Wed Oct 21 21:30:18 2020 +0200
@@ -170,6 +170,17 @@
 apply(tmi::IdentityMapping{T,D}, v::AbstractArray{T,D}, I::Vararg{Any,D}) where {T,D} = v[I...]
 apply_transpose(tmi::IdentityMapping{T,D}, v::AbstractArray{T,D}, I::Vararg{Any,D}) where {T,D} = v[I...]
 
+"""
+    InflatedTensorMapping{T,R,D} <: TensorMapping{T,R,D}
+
+An inflated `TensorMapping` with dimensions added before and afer its actual dimensions.
+
+---
+
+    InflatedTensorMapping(before, tm, after)
+
+The outer product of `before`, `tm` and `after`, where `before` and `after` are `IndentityMapping`s.
+"""
 struct InflatedTensorMapping{T,R,D,D_before,R_middle,D_middle,D_after, TM<:TensorMapping{T,R_middle,D_middle}} <: TensorMapping{T,R,D}
     before::IdentityMapping{T,D_before}
     tm::TM