Skip to content

Commit 402b76f

Browse files
JanLucaJanLuca
committed
Update API docs
1 parent bdc2791 commit 402b76f

File tree

3 files changed

+73
-4
lines changed

3 files changed

+73
-4
lines changed

‎varipeps/contractions/apply.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,12 @@ def apply_contraction(
6767
disable_identity_check (:obj:`bool`):
6868
Disable the check if the tensor is identical to the one of the
6969
corresponding object.
70+
custom_definition (:obj:`~varipeps.contractions.apply.Definition`, optional):
71+
Use a custom definition for the contraction which is not defined in the
72+
:class:`varipeps.contractions.Definitions` class.
73+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
74+
Global configuration object of the variPEPS library. Please see its
75+
class definition for details.
7076
Returns:
7177
jax.numpy.ndarray:
7278
The contracted tensor.

‎varipeps/ctmrg/absorption.py‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,13 @@ def do_left_absorption(
110110
The sequence of unique PEPS tensors the unitcell consists of.
111111
unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
112112
The unitcell to work on.
113+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
114+
Global configuration object of the variPEPS library. Please see its
115+
class definition for details.
116+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
117+
Global state object of the variPEPS library. It is used to transport
118+
a common state across different parts of the framework. Please see its
119+
class definition for details.
113120
Returns:
114121
:obj:`~varipeps.peps.PEPS_Unit_Cell`:
115122
New instance of the unitcell with the updated left CTMRG tensors of
@@ -202,6 +209,13 @@ def do_right_absorption(
202209
The sequence of unique PEPS tensors the unitcell consists of.
203210
unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
204211
The unitcell to work on.
212+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
213+
Global configuration object of the variPEPS library. Please see its
214+
class definition for details.
215+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
216+
Global state object of the variPEPS library. It is used to transport
217+
a common state across different parts of the framework. Please see its
218+
class definition for details.
205219
Returns:
206220
:obj:`~varipeps.peps.PEPS_Unit_Cell`:
207221
New instance of the unitcell with the updated right CTMRG tensors of
@@ -298,6 +312,13 @@ def do_top_absorption(
298312
The sequence of unique PEPS tensors the unitcell consists of.
299313
unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
300314
The unitcell to work on.
315+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
316+
Global configuration object of the variPEPS library. Please see its
317+
class definition for details.
318+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
319+
Global state object of the variPEPS library. It is used to transport
320+
a common state across different parts of the framework. Please see its
321+
class definition for details.
301322
Returns:
302323
:obj:`~varipeps.peps.PEPS_Unit_Cell`:
303324
New instance of the unitcell with the updated top CTMRG tensors of
@@ -390,6 +411,13 @@ def do_bottom_absorption(
390411
The sequence of unique PEPS tensors the unitcell consists of.
391412
unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
392413
The unitcell to work on.
414+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
415+
Global configuration object of the variPEPS library. Please see its
416+
class definition for details.
417+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
418+
Global state object of the variPEPS library. It is used to transport
419+
a common state across different parts of the framework. Please see its
420+
class definition for details.
393421
Returns:
394422
:obj:`~varipeps.peps.PEPS_Unit_Cell`:
395423
New instance of the unitcell with the updated bottom CTMRG tensors of
@@ -583,6 +611,13 @@ def do_absorption_step(
583611
The sequence of unique PEPS tensors the unitcell consists of.
584612
unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
585613
The unitcell to work on.
614+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
615+
Global configuration object of the variPEPS library. Please see its
616+
class definition for details.
617+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
618+
Global state object of the variPEPS library. It is used to transport
619+
a common state across different parts of the framework. Please see its
620+
class definition for details.
586621
Returns:
587622
:obj:`~varipeps.peps.PEPS_Unit_Cell`:
588623
New instance of the unitcell with the all updated CTMRG tensors of

‎varipeps/ctmrg/projectors.py‎

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -324,8 +324,15 @@ def calc_left_projectors(
324324
to the x axis, the column (second) index to y.
325325
peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
326326
Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
327+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
328+
Global configuration object of the variPEPS library. Please see its
329+
class definition for details.
330+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
331+
Global state object of the variPEPS library. It is used to transport
332+
a common state across different parts of the framework. Please see its
333+
class definition for details.
327334
Returns:
328-
:obj:`tuple`\ (:obj:`jax.numpy.ndarray`, :obj:`jax.numpy.ndarray`):
335+
:obj:`~varipeps.utils.projector_dict.Left_Projectors`:
329336
The left top and bottom projectors.
330337
"""
331338
chi = _check_chi(peps_tensor_objs)
@@ -435,8 +442,15 @@ def calc_right_projectors(
435442
to the x axis, the column (second) index to y.
436443
peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
437444
Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
445+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
446+
Global configuration object of the variPEPS library. Please see its
447+
class definition for details.
448+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
449+
Global state object of the variPEPS library. It is used to transport
450+
a common state across different parts of the framework. Please see its
451+
class definition for details.
438452
Returns:
439-
:obj:`tuple`\ (:obj:`jax.numpy.ndarray`, :obj:`jax.numpy.ndarray`):
453+
:obj:`~varipeps.utils.projector_dict.Right_Projectors`:
440454
The right top and bottom projectors.
441455
"""
442456
chi = _check_chi(peps_tensor_objs)
@@ -546,8 +560,15 @@ def calc_top_projectors(
546560
to the x axis, the column (second) index to y.
547561
peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
548562
Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
563+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
564+
Global configuration object of the variPEPS library. Please see its
565+
class definition for details.
566+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
567+
Global state object of the variPEPS library. It is used to transport
568+
a common state across different parts of the framework. Please see its
569+
class definition for details.
549570
Returns:
550-
:obj:`tuple`\ (:obj:`jax.numpy.ndarray`, :obj:`jax.numpy.ndarray`):
571+
:obj:`~varipeps.utils.projector_dict.Top_Projectors`:
551572
The top left and right projectors.
552573
"""
553574
chi = _check_chi(peps_tensor_objs)
@@ -657,8 +678,15 @@ def calc_bottom_projectors(
657678
to the x axis, the column (second) index to y.
658679
peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
659680
Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
681+
config (:obj:`~varipeps.config.PEPS_AD_Config`):
682+
Global configuration object of the variPEPS library. Please see its
683+
class definition for details.
684+
state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
685+
Global state object of the variPEPS library. It is used to transport
686+
a common state across different parts of the framework. Please see its
687+
class definition for details.
660688
Returns:
661-
:obj:`tuple`\ (:obj:`jax.numpy.ndarray`, :obj:`jax.numpy.ndarray`):
689+
:obj:`~varipeps.utils.projector_dict.Bottom_Projectors`:
662690
The bottom left and right projectors.
663691
"""
664692
chi = _check_chi(peps_tensor_objs)

0 commit comments

Comments
 (0)