added docs for evaluate_mps

Author: rittermarc

src/mpsutil.jl

@@ -1,3 +1,15 @@
+@doc raw"""
+    function evaluate_mps(
+        mps::Union{ITensors.MPS,ITensors.MPO},
+        indexspecs::Vararg{AbstractVector{<:Tuple{ITensors.Index,Int}}}
+    )
+
+Evaluates an MPS or MPO for a given set of index values.
+
+- `indexspec` is a list of tuples, where each tuple contains an `Itensors.Index` object specifying an index, and an `Int` corresponding to the value of the specified index.
+
+If many evaluations are necessary, it may be advantageous to convert your MPS to a `TensorCrossInterpolation.TTCache` object first.
+"""
 function evaluate_mps(
     mps::Union{ITensors.MPS,ITensors.MPO},
     indexspecs::Vararg{AbstractVector{<:Tuple{ITensors.Index,Int}}}
@@ -15,7 +27,20 @@ function evaluate_mps(
     end
     return scalar(V)
 end
+@doc raw"""
+    function evaluate_mps(
+        mps::Union{ITensors.MPS,ITensors.MPO},
+        indices::AbstractVector{<:ITensors.Index},
+        indexvalues::AbstractVector{Int}
+    )
+
+Evaluates an MPS or MPO for a given set of index values.
+
+- `indices` is a list of `ITensors.Index` objects that specifies the order in which indices are given.
+- `indexvalues` is a list of integer values in the same order as `indices`.
 
+If many evaluations are necessary, it may be advantageous to convert your MPS to a `TensorCrossInterpolation.TTCache` object first.
+"""
 function evaluate_mps(
     mps::Union{ITensors.MPS,ITensors.MPO},
     indices::AbstractVector{<:ITensors.Index},