Rename @default_kwargs -> @define_default_kwargs

Author: Jack Dunham

src/solvers/applyexp.jl

@@ -20,7 +20,7 @@ function region_plan(A::ApplyExpProblem; nsites, exponent_step, sweep_kwargs...)
   return applyexp_regions(state(A), exponent_step; nsites, sweep_kwargs...)
 end
 
-@default_kwargs function update!(
+@define_default_kwargs function update!(
   region_iter::RegionIterator{<:ApplyExpProblem},
   local_state;
   nsites,

src/solvers/default_kwargs.jl

@@ -14,12 +14,12 @@ end
 default_kwargs(f::Function, ::Vararg{<:Type}; kwargs...) = (; kwargs...)
 
 """
-    @default_kwargs
+    @define_default_kwargs
 
 Automatically define a `default_kwargs` method for a given function. This macro should
 be applied before a function definition:
 ```
-@default_kwargs astypes = true function f(args...; kwargs...) 
+@define_default_kwargs astypes = true function f(args...; kwargs...) 
   ...
 end
 ```
@@ -30,7 +30,7 @@ default_kwargs(::typeof(f), arg::T; kwargs...) # astypes = false
 default_kwargs(::typeof(f), arg::Type{<:T}; kwargs...) # astypes = true
 ```
 """
-macro default_kwargs(args...)
+macro define_default_kwargs(args...)
   kwargs = (;)
   for opt in args
     if @capture(opt, key_ = val_)
@@ -46,7 +46,7 @@ end
 function default_kwargs_macro(function_def; astypes=true)
   if !isdef(function_def)
     throw(
-      ArgumentError("The @default_kwargs macro must be followed by a function definition")
+      ArgumentError("The @define_default_kwargs macro must be followed by a function definition")
     )
   end
 

src/solvers/eigsolve.jl

@@ -20,7 +20,7 @@ function set_truncation_info!(E::EigsolveProblem; spectrum=nothing)
   return E
 end
 
-@default_kwargs function update!(
+@define_default_kwargs function update!(
   region_iter::RegionIterator{<:EigsolveProblem},
   local_state;
   outputlevel=0,

src/solvers/fitting.jl

@@ -44,7 +44,7 @@ function extract!(region_iter::RegionIterator{<:FittingProblem})
   return local_tensor
 end
 
-@default_kwargs function update!(
+@define_default_kwargs function update!(
   region_iter::RegionIterator{<:FittingProblem}, local_tensor; outputlevel=0
 )
   F = problem(region_iter)

src/solvers/subspace/densitymatrix.jl

@@ -1,7 +1,7 @@
 using NamedGraphs.GraphsExtensions: incident_edges
 using Printf: @printf
 
-@default_kwargs function subspace_expand!(
+@define_default_kwargs function subspace_expand!(
   ::Backend"densitymatrix", region_iter, local_state; north_pass=1
 )
   prob = problem(region_iter)

src/solvers/subspace/subspace.jl

@@ -1,7 +1,7 @@
 using NDTensors: NDTensors
 using NDTensors.BackendSelection: Backend, @Backend_str
 
-@default_kwargs function subspace_expand!(
+@define_default_kwargs function subspace_expand!(
   region_iter, local_state; subspace_algorithm="nothing"
 )
   backend = Backend(subspace_algorithm)

test/solvers/test_default_kwargs.jl

@@ -4,15 +4,15 @@ using ITensorNetworks: AbstractProblem, default_kwargs, RegionIterator, problem,
 module KwargsTestModule
 
 using ITensorNetworks
-using ITensorNetworks: AbstractProblem, @default_kwargs
+using ITensorNetworks: AbstractProblem, @define_default_kwargs
 
 struct TestProblem <: AbstractProblem end
 struct NotOurTestProblem <: AbstractProblem end
 
-@default_kwargs astypes = true function test_function(::AbstractProblem; bool=false, int=3)
+@define_default_kwargs astypes = true function test_function(::AbstractProblem; bool=false, int=3)
   return bool, int
 end
-@default_kwargs astypes = true function test_function(::TestProblem; bool=true, int=0)
+@define_default_kwargs astypes = true function test_function(::TestProblem; bool=true, int=0)
   return bool, int
 end