Skip to content

Commit b003332

Browse files
committed
Move docstring to src
1 parent cab6d63 commit b003332

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/tensor_operations/tensor_algebra.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,12 @@ function contract(
130130
end
131131
end
132132

133+
"""
134+
optimal_contraction_sequence(T)
135+
136+
Returns a contraction sequence for contracting the tensors `T`. The sequence is
137+
generally optimal and is found via the optimaltree function in TensorOperations.jl which must be loaded.
138+
"""
133139
function optimal_contraction_sequence(As)
134140
return throw(
135141
ArgumentError(

0 commit comments

Comments
 (0)