Merge branch '45-needed-an-option-to-force-tci2-use-batch-evaluation' into 'main'

Resolve "Needed an option to force TCI2 use batch evaluation"

Closes #45

See merge request tensors4fields/TensorCrossInterpolation.jl!86

Author: shinaoka

src/tensorci2.jl

@@ -587,6 +587,8 @@ function convergencecriterion(
     ) || all(lastranks .>= maxbonddim)
 end
 
+
+
 """
     function optimize!(
         tci::TensorCI2{ValueType},
@@ -628,6 +630,7 @@ Arguments:
 - `nsearchglobalpivot::Int` can be set to `>= 0`. Default: `0`.
 - `tolmarginglobalsearch` can be set to `>= 1.0`. Seach global pivots where the interpolation error is larger than the tolerance by `tolmarginglobalsearch`.  Default: `10.0`.
 - `strictlynested::Bool` determines whether to preserve partial nesting in the TCI algorithm. Default: `false`.
+- `checkbatchevaluatable::Bool` Check if the function `f` is batch evaluatable. Default: `false`.
 
 Notes:
 - Set `tolerance` to be > 0 or `maxbonddim` to some reasonable value. Otherwise, convergence is not reachable.
@@ -652,12 +655,17 @@ function optimize!(
     maxnglobalpivot::Int=5,
     nsearchglobalpivot::Int=0,
     tolmarginglobalsearch::Float64=10.0,
-    strictlynested::Bool=false
+    strictlynested::Bool=false,
+    checkbatchevaluatable::Bool=false
 ) where {ValueType}
     errors = Float64[]
     ranks = Int[]
     nglobalpivots = Int[]
 
+    if checkbatchevaluatable && !(f isa BatchEvaluator)
+        error("Function `f` is not batch evaluatable")
+    end
+
     #if maxnglobalpivot > 0 && nsearchglobalpivot > 0
         #!strictlynested || error("nglobalpivots > 0 requires strictlynested=false!")
     #end
@@ -868,6 +876,7 @@ Arguments:
 - `nsearchglobalpivot::Int` can be set to `>= 0`. Default: `0`.
 - `tolmarginglobalsearch` can be set to `>= 1.0`. Seach global pivots where the interpolation error is larger than the tolerance by `tolmarginglobalsearch`.  Default: `10.0`.
 - `strictlynested::Bool=true` determines whether to preserve partial nesting in the TCI algorithm. Default: `true`.
+- `checkbatchevaluatable::Bool` Check if the function `f` is batch evaluatable. Default: `false`.
 
 Notes:
 - Set `tolerance` to be > 0 or `maxbonddim` to some reasonable value. Otherwise, convergence is not reachable.

test/runtests.jl

@@ -17,13 +17,4 @@ include("test_tensorci1.jl")
 include("test_tensorci2.jl")
 include("test_tensortrain.jl")
 include("test_contraction.jl")
-include("test_integration.jl")
-
-#==
-if VERSION.major >= 2 || (VERSION.major == 1 && VERSION.minor >= 9)
-    @testset "ITensor conversion interface" begin
-        include("test_ttmpsconversion.jl")
-        include("test_mpsutil.jl")
-    end
-end
-==#
+include("test_integration.jl")

test/test_tensorci2.jl

@@ -37,6 +37,19 @@ import QuanticsGrids as QD
         @test tci.pivoterrors == diags
     end
 
+    @testset "checkbatchevaluatable" begin
+        f(x) = 1.0 # Constant function without batch evaluation
+        L = 10
+        localdims = fill(2, L)
+        firstpivots = [fill(1, L)]
+        @test_throws ErrorException crossinterpolate2(
+            Float64,
+            f,
+            localdims,
+            firstpivots;
+            checkbatchevaluatable=true
+        )
+    end
 
     @testset "trivial MPS(exp): pivotsearch=$pivotsearch" for pivotsearch in [:full, :rook], strictlynested in [false, true], nsearchglobalpivot in [0, 10]
         if nsearchglobalpivot > 0 && strictlynested