changeset 193:2d97c54fd1f1 boundary_conditions

Change documentation of LazyElementWiseOperation to docstring
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 20 Jun 2019 23:05:12 +0200
parents 4799bc46eaa9
children d30d42a11566
files LazyTensors/src/Lazy.jl
diffstat 1 files changed, 10 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/LazyTensors/src/Lazy.jl	Thu Jun 20 23:02:37 2019 +0200
+++ b/LazyTensors/src/Lazy.jl	Thu Jun 20 23:05:12 2019 +0200
@@ -1,9 +1,15 @@
 module Lazy
 
-# Struct allowing for lazy evaluation of operations on AbstractArrays
-# A LazyElementwiseOperation is defined by two same-sized AbstractArrays
-# together with an operation. The operations are carried out when the
-# LazyElementwiseOperation is indexed.
+
+"""
+    LazyElementwiseOperation{T,D,Op, T1<:AbstractArray{T,D}, T2 <: AbstractArray{T,D}} <: AbstractArray{T,D}
+
+Struct allowing for lazy evaluation of elementwise operations on AbstractArrays.
+
+A LazyElementwiseOperation contains two AbstractArrays of equal size,
+together with an operation. The operations are carried out when the
+LazyElementwiseOperation is indexed.
+"""
 struct LazyElementwiseOperation{T,D,Op, T1<:AbstractArray{T,D}, T2 <: AbstractArray{T,D}} <: AbstractArray{T,D}
     a::T1
     b::T2