diff --git a/docs/common.html b/docs/common.html index 7d67fa6..9cb6c16 100644 --- a/docs/common.html +++ b/docs/common.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Common @@ -272,143 +272,143 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summary

+
+

1 Summary

-
-

2 Angular Momentum

+
+

2 Angular Momentum

Azimuthal quantum number, repsesented as \( s,p,d,\dots \) .

-
-

2.1 Type

+
+

2.1 Type

-Angular_momentum.t +Angular_momentum.t

-
type t =
+
type t =
   | S | P | D | F | G | H | I | J | K | L | M | N | O
   | Int of int
 
@@ -424,7 +424,7 @@ Azimuthal quantum number, repsesented as \( s,p,d,\dots \) .
 

-An exception is raised when the Angular_momentum.t element can't +An exception is raised when the Angular_momentum.t element can't be created.

@@ -435,8 +435,8 @@ quartets, use in the two-electron operators.
-
-

2.2 Conversions

+
+

2.2 Conversions

val of_char : char -> t
@@ -460,7 +460,7 @@ quartets, use in the two-electron operators.
 
 
 of_char
-Returns an Angular_momentum.t when a shell is given as  a character (case insensitive)
+Returns an Angular_momentum.t when a shell is given as  a character (case insensitive)
 
 
 
@@ -488,7 +488,7 @@ quartets, use in the two-electron operators.
 

Example:

-
+
 Angular_momentum.of_char 'p';;
 - : Angular_momentum.t = P
 
@@ -507,8 +507,8 @@ Angular_momentum.(to_string D);;
 
-
-

2.3 Shell functions

+
+

2.3 Shell functions

val n_functions : t -> int
@@ -532,7 +532,7 @@ Angular_momentum.(to_string D);;
 
 
 zkey_array
-Array of Zkey.t, where each element is a a key associated with the the powers of \(x,y,z\).
+Array of Zkey.t, where each element is a a key associated with the the powers of \(x,y,z\).
 
 
 
@@ -540,7 +540,7 @@ Angular_momentum.(to_string D);;
 

Example:

-
+
 Angular_momentum.(n_functions D) ;;
 - : int = 6
 
@@ -553,8 +553,8 @@ Angular_momentum.( zkey_array (Doublet (P,S)) );;
 
-
-

2.4 Arithmetic

+
+

2.4 Arithmetic

val ( + ) : t -> t -> t
@@ -565,7 +565,7 @@ Angular_momentum.( zkey_array (Doublet (P,S)) );;
 

Example:

-
+
 Angular_momentum.(D + P);;
 - : Angular_momentum.t = F
 
@@ -575,8 +575,8 @@ Angular_momentum.(F - P);;
 
-
-

2.5 Printers

+
+

2.5 Printers

Printers can print as a string (default) or as an integer. @@ -591,12 +591,12 @@ Printers can print as a string (default) or as an integer.

-
-

2.6 TODO Tests

+
+

2.6 TODO Tests

-
-

3 Bit string

+
+

3 Bit string

We define here a data type to handle bit strings efficiently. When @@ -608,11 +608,11 @@ bit string as a multi-precision integer.

-
-

3.1 Type

+
+

3.1 Type

-Bitstring.t +Bitstring.t

type t
@@ -621,8 +621,8 @@ bit string as a multi-precision integer.
 
-
-

3.2 General implementation

+
+

3.2 General implementation

val of_int : int -> t
@@ -774,7 +774,7 @@ bit string as a multi-precision integer.
 

Example:

-
+
 Bitstring.of_int 15;;
 - : Bitstring.t =
 ++++------------------------------------------------------------
@@ -783,7 +783,7 @@ Bitstring.of_int 15;;
 

Example:

-
+
 Bitstring.(shift_left (of_int 15) 2);;
 - : Bitstring.t =
 --++++----------------------------------------------------------
@@ -806,7 +806,7 @@ Bitstring.(testbit (of_int 15) 4);;
 

Example:

-
+
 Bitstring.(logor (of_int 15) (of_int 73));;
 - : Bitstring.t =
 ++++--+---------------------------------------------------------
@@ -824,7 +824,7 @@ Bitstring.(logxor (of_int 15) (of_int 73));;
 

Example:

-
+
 Bitstring.(plus_one (of_int 15));;
 - : Bitstring.t =
 ----+-----------------------------------------------------------
@@ -838,7 +838,7 @@ Bitstring.(minus_one (of_int 15));;
 

Example:

-
+
 Bitstring.(trailing_zeros (of_int 12));;
 - : int = 2
 
@@ -852,7 +852,7 @@ Bitstring.(popcount (of_int 15));;
 

Example:

-
+
 Bitstring.(to_list (of_int 45));;
 - : int list = [1; 3; 4; 6]
 
@@ -860,7 +860,7 @@ Bitstring.(to_list (of_int 45));;

Example:

-
+
    Bitstring.permutations 2 4;;
 - : Bitstring.t list =
 [++--------------------------------------------------------------;
@@ -873,8 +873,8 @@ Example:
 
-
-

3.3 Printers

+
+

3.3 Printers

val pp : Format.formatter -> t -> unit
@@ -884,16 +884,16 @@ Example:
 
-
-

4 Charge

+
+

4 Charge

-
-

4.1 Type

+
+

4.1 Type

-Charge.t +Charge.t

type t
@@ -906,8 +906,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

4.2 Conversions

+
+

4.2 Conversions

val of_float : float -> t
@@ -923,8 +923,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

4.3 Simple operations

+
+

4.3 Simple operations

val ( + ) : t -> t -> t
@@ -937,8 +937,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

4.4 Printers

+
+

4.4 Printers

val pp : Format.formatter -> t -> unit
@@ -948,8 +948,8 @@ This type should be used for all charges in the program (electrons, nuclei, 
 
-
-

5 Command line

+
+

5 Command line

This module is a wrapper around the Getopt library and helps to @@ -1005,11 +1005,11 @@ Then, define what to do with the arguments:

-
-

5.1 Types

+
+

5.1 Types

-
type short_opt     = char
+
type short_opt     = char
 type long_opt      = string
 type optional      = Mandatory | Optional
 type documentation = string
@@ -1029,9 +1029,9 @@ Then, define what to do with the arguments:
 
    -
  • Short option: in the command line, a dash with a single character +
  • Short option: in the command line, a dash with a single character (ex: ls -l)
  • -
  • Long option: in the command line, two dashes with a word +
  • Long option: in the command line, two dashes with a word (ex: ls --directory)
  • Command-line options can be Mandatory or Optional
  • Documentation of the option is used in the help function
  • @@ -1042,12 +1042,12 @@ don't (ls -l) and for some arguments the argument is optional
-
-

5.2 Mutable attributes

+
+

5.2 Mutable attributes

All the options are stored in the hash table dict where the key -is the long option and the value is a value of type description. +is the long option and the value is a value of type description.

@@ -1073,8 +1073,8 @@ Function to create an anonymous argument.
-
-

5.3 Query functions

+
+

5.3 Query functions

val get       : long_opt -> string option
@@ -1094,7 +1094,7 @@ Function to create an anonymous argument.
 
 
 get
-Returns the argument associated with a long option
+Returns the argument associated with a long option
 
 
 
@@ -1112,8 +1112,8 @@ Function to create an anonymous argument.
 
-
-

5.4 Specification

+
+

5.4 Specification

val set_specs : description list -> unit
@@ -1128,16 +1128,16 @@ Sets the specifications of the current program from a list of
 
-
-

6 Constants

+
+

6 Constants

All constants used in the program.

-
-

6.1 Thresholds

+
+

6.1 Thresholds

val epsilon          : float
@@ -1168,8 +1168,8 @@ All constants used in the program.
 
-
-

6.2 Mathematical constants

+
+

6.2 Mathematical constants

val pi             : float
@@ -1224,8 +1224,8 @@ All constants used in the program.
 
-
-

6.3 Physical constants

+
+

6.3 Physical constants

val a0       : float
@@ -1269,8 +1269,8 @@ All constants used in the program.
 
-
-

7 Coordinate

+
+

7 Coordinate

Coordinates in 3D space. @@ -1283,14 +1283,14 @@ module.

-
-

7.1 Type

+
+

7.1 Type

-Coordinate.t +Coordinate.t

-
type bohr 
+
type bohr 
 type angstrom 
 
 type xyz = {
@@ -1309,8 +1309,8 @@ module.
 
-
-

7.2 Creation

+
+

7.2 Creation

val make          : 'a point -> t
@@ -1347,8 +1347,8 @@ module.
 
-
-

7.3 Conversion

+
+

7.3 Conversion

val bohr_to_angstrom : bohr point -> angstrom point
@@ -1379,8 +1379,8 @@ module.
 
-
-

7.4 Vector operations

+
+

7.4 Vector operations

val neg    : t -> t
@@ -1442,7 +1442,7 @@ module.
 

Example:

-
+
 Coordinate.neg { x=1. ; y=2. ; z=3. } ;;
 - : Coordinate.t =  -1.0000  -2.0000  -3.0000
 
@@ -1468,8 +1468,8 @@ Coordinate.(
 
-
-

7.5 Printers

+
+

7.5 Printers

val pp : Format.formatter -> t -> unit
@@ -1485,16 +1485,16 @@ Coordinates can be printed in bohr or angstrom.
 
-
-

8 Non-negative float

+
+

8 Non-negative float

-
-

8.1 Type

+
+

8.1 Type

-< +<

type t = private float
@@ -1503,8 +1503,8 @@ Coordinates can be printed in bohr or angstrom.
 
-
-

8.2 Conversions

+
+

8.2 Conversions

val of_float        : float -> t
@@ -1524,19 +1524,19 @@ The unsafe variant doesn't do this check.
 
-
-

9 Powers

+
+

9 Powers

Contains powers of \(x\), \(y\) and \(z\) describing the polynomials in atomic basis sets.

-
-

9.1 Type

+
+

9.1 Type

-Powers.t +Powers.t

type t = private {
@@ -1554,8 +1554,8 @@ Contains powers of \(x\), \(y\) and \(z\) describing the polynomials in atomic b
 
-
-

9.2 Conversions

+
+

9.2 Conversions

val of_int_tuple : int * int * int -> t
@@ -1566,7 +1566,7 @@ Contains powers of \(x\), \(y\) and \(z\) describing the polynomials in atomic b
 

Example:

-
+
 Powers.of_int_tuple (2,3,1);;
 - : Powers.t = x^2 + y^3 + z^1
 
@@ -1576,8 +1576,8 @@ Powers.(to_int_tuple (of_int_tuple (2,3,1)));;
 
-
-

9.3 Operations

+
+

9.3 Operations

val get  : Coordinate.axis -> t -> int
@@ -1602,12 +1602,12 @@ Powers.(to_int_tuple (of_int_tuple (2,3,1)));;
 
 
 incr
-Returns a new Powers.t with the power on the given axis incremented
+Returns a new Powers.t with the power on the given axis incremented
 
 
 
 decr
-Returns a new Powers.t with the power on the given axis decremented. As opposed to of_int_tuple, the values may become negative
+Returns a new Powers.t with the power on the given axis decremented. As opposed to of_int_tuple, the values may become negative
 
 
 
@@ -1615,7 +1615,7 @@ Powers.(to_int_tuple (of_int_tuple (2,3,1)));;
 

Example:

-
+
 Powers.get Coordinate.Y (Powers.of_int_tuple (2,3,1));;
 - : int = 3
 
@@ -1629,8 +1629,8 @@ Powers.decr Coordinate.Y (Powers.of_int_tuple (2,3,1));;
 
-
-

9.4 Printers

+
+

9.4 Printers

val pp : Format.formatter -> t -> unit
@@ -1640,8 +1640,8 @@ Powers.decr Coordinate.Y (Powers.of_int_tuple (2,3,1));;
 
-
-

10 QCaml

+
+

10 QCaml

QCaml-specific parameters @@ -1676,8 +1676,8 @@ QCaml-specific parameters

-
-

11 Range

+
+

11 Range

A range is a sorted list of integers in an interval. @@ -1692,11 +1692,11 @@ A range is a sorted list of integers in an interval.

-
-

11.1 Type

+
+

11.1 Type

-Range.t +Range.t

type t
@@ -1705,8 +1705,8 @@ A range is a sorted list of integers in an interval.
 
-
-

11.2 Conversion

+
+

11.2 Conversion

val of_string   : string -> t
@@ -1717,8 +1717,8 @@ A range is a sorted list of integers in an interval.
 
-
-

11.3 Printers

+
+

11.3 Printers

val pp : Format.formatter -> t -> unit
@@ -1728,19 +1728,19 @@ A range is a sorted list of integers in an interval.
 
-
-

12 Spin

+
+

12 Spin

Electron spin

-
-

12.1 Type

+
+

12.1 Type

-Spin.t +Spin.t

type t = Alfa | Beta
@@ -1755,8 +1755,8 @@ letters as Beta, so the alignment of the code is nicer.
 
-
-

12.2 Functions

+
+

12.2 Functions

val other : t -> t
@@ -1769,8 +1769,8 @@ Returns the opposite spin
 
-
-

12.3 Printers

+
+

12.3 Printers

val pp : Format.formatter -> t -> unit
@@ -1780,8 +1780,8 @@ Returns the opposite spin
 
-
-

13 Util

+
+

13 Util

Utility functions. @@ -1789,8 +1789,8 @@ Utility functions.

-
-

13.1 External C functions

+
+

13.1 External C functions

@@ -1834,8 +1834,8 @@ Utility functions.
-
-

13.1.1 Erf

+
+

13.1.1 Erf

external erf_float : float -> float
@@ -1845,8 +1845,8 @@ Utility functions.
 
-
-

13.1.2 Erfc

+
+

13.1.2 Erfc

external erfc_float : float -> float
@@ -1856,8 +1856,8 @@ Utility functions.
 
-
-

13.1.3 Gamma

+
+

13.1.3 Gamma

external gamma_float : float -> float
@@ -1867,8 +1867,8 @@ Utility functions.
 
-
-

13.1.4 Popcnt

+
+

13.1.4 Popcnt

val popcnt : int64 -> int
@@ -1877,8 +1877,8 @@ Utility functions.
 
-
-

13.1.5 Trailz

+
+

13.1.5 Trailz

val trailz : int64 -> int
@@ -1887,8 +1887,8 @@ Utility functions.
 
-
-

13.1.6 Leadz

+
+

13.1.6 Leadz

val leadz : int64 -> int
@@ -1897,13 +1897,13 @@ Utility functions.
 
-
-

13.1.7 Test

+
+

13.1.7 Test

-
-

13.2 General functions

+
+

13.2 General functions

val fact : int -> float
@@ -1976,8 +1976,8 @@ Utility functions.
 
-
-

13.3 Functions related to the Boys function

+
+

13.3 Functions related to the Boys function

val incomplete_gamma : alpha:float -> float -> float
@@ -2034,8 +2034,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

13.4 List functions

+
+

13.4 List functions

val list_some  : 'a option list -> 'a list
@@ -2072,8 +2072,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

13.5 Array functions

+
+

13.5 Array functions

val array_range   : int -> int -> int array
@@ -2110,8 +2110,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

13.6 Stream functions

+
+

13.6 Stream functions

val stream_range   : int -> int -> int Stream.t
@@ -2148,8 +2148,8 @@ where \(\gamma\) is the incomplete gamma function.
 
-
-

13.7 Printers

+
+

13.7 Printers

val pp_float_array_size   : Format.formatter -> float array -> unit
@@ -2199,7 +2199,7 @@ where \(\gamma\) is the incomplete gamma function.
 

Example:

-
+
 pp_float_array_size:
 [ 6:   1.000000   1.732051   1.732051   1.000000   1.732051   1.000000 ]
 
@@ -2222,8 +2222,8 @@ pp_bitstring 14:
 
-
-

14 Zkey

+
+

14 Zkey

Encodes the powers of x, y, z in a compact form, suitable for being @@ -2231,7 +2231,7 @@ used as keys in a hash table.

-Internally, the Zkey.t is made of two integers, left and right. +Internally, the Zkey.t is made of two integers, left and right. The small integers x, y and z are stored compactly in this 126-bits space:

@@ -2239,7 +2239,7 @@ space:

Example:

-
+
                                 Left                                                                Right
  3 [--------------------------------------------------------------]       [------------------|---------------|---------------|---------------]
                                                                                                      x               y               z        
@@ -2260,11 +2260,11 @@ The values of x,y,z should be positive and should not exceed 32767 for
 

-
-

14.1 Types

+
+

14.1 Types

-Zkey.t +Zkey.t

type t 
@@ -2280,8 +2280,8 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

14.2 Conversions

+
+

14.2 Conversions

val of_powers_three  : Powers.t -> t
@@ -2308,22 +2308,22 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
 
 of_powers_three
-Create from a Powers.t
+Create from a Powers.t
 
 
 
 of_powers_six
-Create from two Powers.t
+Create from two Powers.t
 
 
 
 of_powers_nine
-Create from three Powers.t
+Create from three Powers.t
 
 
 
 of_powers_twelve
-Create from four Powers.t
+Create from four Powers.t
 
 
 
@@ -2348,7 +2348,7 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
 
 to_powers
-Convert to an Powers.t array
+Convert to an Powers.t array
 
 
 
@@ -2360,8 +2360,8 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

14.3 Functions for hash tables

+
+

14.3 Functions for hash tables

val hash    : t -> int
@@ -2398,8 +2398,8 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

14.4 Printers

+
+

14.4 Printers

val pp : Format.formatter -> t -> unit
@@ -2409,19 +2409,19 @@ The values of x,y,z should be positive and should not exceed 32767 for
 
-
-

15 Zmap

+
+

15 Zmap

A hash table where the keys are Zkey

-
-

15.1 Type

+
+

15.1 Type

-Zmap.t +Zmap.t

include module type of Hashtbl.Make(Zkey)
@@ -2433,7 +2433,7 @@ A hash table where the keys are Zkey
 

Author: Anthony Scemama

-

Created: 2021-01-28 Thu 00:32

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/docs/gaussian.html b/docs/gaussian.html index f5815df..f0934cf 100644 --- a/docs/gaussian.html +++ b/docs/gaussian.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Gaussian @@ -272,41 +272,41 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summmary

+
+

1 Summary

-
-

2 Atomic shell

+
+

2 Atomic shell

Set of contracted Gaussians differing only by the powers of \(x\), \(y\) and \(z\), with a @@ -339,8 +339,8 @@ particular powers of \(x,y,z\) (PrimitiveShell.norm_coef_scale) -

-

2.1 Type

+
+

2.1 Type

type t
@@ -351,8 +351,8 @@ particular powers of \(x,y,z\) (PrimitiveShell.norm_coef_scale)
 
-
-

2.2 Access

+
+

2.2 Access

val ang_mom           : t -> Angular_momentum.t
@@ -429,14 +429,14 @@ particular powers of \(x,y,z\) (PrimitiveShell.norm_coef_scale)
 
 
-
+
 
 
-
-

2.3 Creation

+
+

2.3 Creation

val make : ?index:int -> Contracted_shell.t array -> t 
@@ -468,8 +468,8 @@ particular powers of \(x,y,z\) (PrimitiveShell.norm_coef_scale)
 
-
-

2.4 Printers

+
+

2.4 Printers

val pp : Format.formatter -> t -> unit
@@ -479,8 +479,8 @@ particular powers of \(x,y,z\) (PrimitiveShell.norm_coef_scale)
 
-
-

3 Atomic shell pair couple

+
+

3 Atomic shell pair couple

An atomic shell pair couple is the cartesian product between two sets of functions, one @@ -496,8 +496,8 @@ acting on different electrons, since they will be coupled by a two-electron oper

-
-

3.1 Type

+
+

3.1 Type

type t
@@ -508,8 +508,8 @@ acting on different electrons, since they will be coupled by a two-electron oper
 
-
-

3.2 Access

+
+

3.2 Access

val ang_mom                       : t -> Angular_momentum.t
@@ -594,8 +594,8 @@ acting on different electrons, since they will be coupled by a two-electron oper
 
-
-

3.3 Creation

+
+

3.3 Creation

val make : ?cutoff:float -> Atomic_shell_pair.t -> Atomic_shell_pair.t -> t option
@@ -621,14 +621,14 @@ Default cutoff is \(\epsilon\).
 
 
 
-
+
 
 
-
-

3.4 Printers

+
+

3.4 Printers

val pp : Format.formatter -> t -> unit
@@ -638,8 +638,8 @@ Default cutoff is \(\epsilon\).
 
-
-

4 Atomic shell pair

+
+

4 Atomic shell pair

Data structure to represent pairs of atomic shells. The products of @@ -651,8 +651,8 @@ An atomic shell pair is an array of pairs of contracted shells.

-
-

4.1 Type

+
+

4.1 Type

type t
@@ -663,8 +663,8 @@ An atomic shell pair is an array of pairs of contracted shells.
 
-
-

4.2 Access

+
+

4.2 Access

val atomic_shell_a         : t -> Atomic_shell.t
@@ -731,8 +731,8 @@ An atomic shell pair is an array of pairs of contracted shells.
 
-
-

4.3 Creation

+
+

4.3 Creation

val make : ?cutoff:float -> Atomic_shell.t -> Atomic_shell.t -> t option
@@ -765,8 +765,8 @@ If an atomic shell pair is not significant, sets the value to None.
 
-
-

4.4 Printers

+
+

4.4 Printers

val pp : Format.formatter -> t -> unit
@@ -778,7 +778,7 @@ If an atomic shell pair is not significant, sets the value to None.
 

Author: Anthony Scemama

-

Created: 2021-01-27 Wed 23:44

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/docs/gaussian_integrals.html b/docs/gaussian_integrals.html index 19705e7..0cd8018 100644 --- a/docs/gaussian_integrals.html +++ b/docs/gaussian_integrals.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Gaussian integrals @@ -250,18 +250,18 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summmary

+
+

1 Summary

Author: Anthony Scemama

-

Created: 2021-01-27 Wed 23:44

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/docs/linear_algebra.html b/docs/linear_algebra.html index 20ba805..08b82c5 100644 --- a/docs/linear_algebra.html +++ b/docs/linear_algebra.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Linear Algebra @@ -250,18 +250,18 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summmary

+
+

1 Summary

Author: Anthony Scemama

-

Created: 2021-01-29 Fri 15:35

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/docs/mo.html b/docs/mo.html index 64999fe..42281fd 100644 --- a/docs/mo.html +++ b/docs/mo.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Molecular orbitals @@ -272,46 +272,46 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summmary

+
+

1 Summary

-
-

2 Frozen core

+
+

2 Frozen core

Defines how the core electrons are frozen, for each atom.

-
-

2.1 Type

+
+

2.1 Type

-
type kind =
+
type kind =
   | All_electron
   | Small
   | Large
@@ -325,8 +325,8 @@ Defines how the core electrons are frozen, for each atom.
 
-
-

2.2 Creation

+
+

2.2 Creation

val make : kind -> Particles.Nuclei.t -> t
@@ -362,7 +362,7 @@ Defines how the core electrons are frozen, for each atom.
 
 
 
-
+
 let f = Frozen_core.(make Small nuclei) ;;
 val f : Frozen_core.t = [|0; 2; 2; 0|]
 
@@ -372,8 +372,8 @@ val f : Frozen_core.t = [|0; 2; 2; 0|]
 
-
-

2.3 Access

+
+

2.3 Access

val num_elec : t -> int
@@ -402,7 +402,7 @@ val f : Frozen_core.t = [|0; 2; 2; 0|]
 
 
 
-
+
 Frozen_core.num_elec f ;;
 - : int = 4
 
@@ -412,8 +412,8 @@ Frozen_core.num_mos f ;;
 
-
-

2.4 Printers

+
+

2.4 Printers

val pp : Format.formatter -> t -> unit
@@ -423,8 +423,8 @@ Frozen_core.num_mos f ;;
 
-
-

3 Orbital localization

+
+

3 Orbital localization

Molecular orbital localization function. @@ -440,11 +440,11 @@ Edmiston-Rudenberg:

-
-

3.1 Type

+
+

3.1 Type

-
open Linear_algebra
+
open Linear_algebra
 
 type localization_kind =
   | Edmiston
@@ -464,16 +464,16 @@ Edmiston-Rudenberg:
 
-
-

3.2 Edmiston-Rudenberg

+
+

3.2 Edmiston-Rudenberg

-
-

3.3 Boys

+
+

3.3 Boys

-
-

3.4 Access

+
+

3.4 Access

val kind         : t -> localization_kind
@@ -522,8 +522,8 @@ Edmiston-Rudenberg:
 
-
-

3.5 Printers

+
+

3.5 Printers

val pp : Format.formatter -> t -> unit
@@ -532,14 +532,14 @@ Edmiston-Rudenberg:
 
-
-

3.6 Tests

+
+

3.6 Tests

Author: Anthony Scemama

-

Created: 2021-02-03 Wed 10:47

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/docs/particles.html b/docs/particles.html index 9990898..f05cf38 100644 --- a/docs/particles.html +++ b/docs/particles.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Common @@ -272,75 +272,75 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summmary

+
+

1 Summary

-
-

2 Electrons

+
+

2 Electrons

Data structure which contains the number of α and β electrons.

-
-

2.1 Type

+
+

2.1 Type

-
type t 
+
type t 
 
-
-

2.2 Creation

+
+

2.2 Creation

open Common
@@ -372,15 +372,15 @@ Data structure which contains the number of α and β electrons.
 
 
 of_atoms
-Creates the data relative to electrons for a molecular system described by Nuclei.t for a given total charge and spin multiplicity.
+Creates the data relative to electrons for a molecular system described by Nuclei.t for a given total charge and spin multiplicity.
 
 
 
 
-
-

2.3 Access

+
+

2.3 Access

val charge       : t -> Charge.t
@@ -429,8 +429,8 @@ Data structure which contains the number of α and β electrons.
 
-
-

2.4 Printers

+
+

2.4 Printers

val pp : Format.formatter -> t -> unit
@@ -439,24 +439,24 @@ Data structure which contains the number of α and β electrons.
 
-
-

2.5 Tests

+
+

2.5 Tests

-
-

3 Element

+
+

3 Element

Chemical elements.

-
-

3.1 Type

+
+

3.1 Type

-
type t =
+
type t =
   |X
   |H                                                 |He
   |Li|Be                              |B |C |N |O |F |Ne
@@ -473,8 +473,8 @@ Chemical elements.
 
-
-

3.2 Conversion

+
+

3.2 Conversion

val of_string      : string -> t
@@ -535,7 +535,7 @@ Chemical elements.
 
 
 
-
+
 Element.of_string "Fe" ;;
 - : Element.t = Particles.Element.Fe
 
@@ -554,8 +554,8 @@ Element.(to_string Fe);;
 
-
-

3.3 Database information

+
+

3.3 Database information

val covalent_radius : t -> Non_negative_float.t
@@ -604,8 +604,8 @@ Element.(to_string Fe);;
 
-
-

3.4 Printers

+
+

3.4 Printers

val pp      : Format.formatter -> t -> unit
@@ -616,34 +616,34 @@ Element.(to_string Fe);;
 
-
-

4 Atomic mass

+
+

4 Atomic mass

Atomic mass, a non-negative float.

-
include module type of Common.Non_negative_float
+
include module type of Common.Non_negative_float
 
-
-

5 Nuclei

+
+

5 Nuclei

-
-

5.1 Type

+
+

5.1 Type

-Nuclei.t +Nuclei.t

-
open Common
+
open Common
 
 type t = (Element.t * Coordinate.t) array
 
@@ -651,12 +651,12 @@ Atomic mass, a non-negative float.
-
-

5.2 xyz file lexer/parser

+
+

5.2 xyz file lexer/parser

-
-

5.2.1 Lexer

+
+

5.2.1 Lexer

nuclei_lexer.mll contains the description of the lexemes used in @@ -709,8 +709,8 @@ rule read_all = parse

-
-

5.2.2 Parser

+
+

5.2.2 Parser

xyz_parser.mly parses nuclear coordinates in xyz format. @@ -829,8 +829,8 @@ an xyz_file data structure.

-
-

5.3 Conversion

+
+

5.3 Conversion

val of_xyz_string : string -> t
@@ -889,8 +889,8 @@ an xyz_file data structure.
 
-
-

5.4 TODO Query

+
+

5.4 TODO Query

val formula    : t -> string
@@ -939,8 +939,8 @@ an xyz_file data structure.
 
-
-

5.5 Printers

+
+

5.5 Printers

val pp : Format.formatter -> t -> unit
@@ -949,31 +949,31 @@ an xyz_file data structure.
 
-
-

5.6 Tests

+
+

5.6 Tests

-
-

6 Z-matrix

+
+

6 Z-matrix

Z-matrix representation of nuclear coordinates.

-
-

6.1 Type

+
+

6.1 Type

-
type t 
+
type t 
 
-
-

6.2 Conversion

+
+

6.2 Conversion

val of_string      : string -> t
@@ -1008,7 +1008,7 @@ Z-matrix representation of nuclear coordinates.
 
 
 
-
+
 let zmt = Zmatrix.of_string "
  n
  n    1 nn
@@ -1053,8 +1053,8 @@ H -0.568803 -0.793910 1.726048"
 
-
-

6.3 Printers

+
+

6.3 Printers

val pp : Format.formatter -> t -> unit
@@ -1066,7 +1066,7 @@ H -0.568803 -0.793910 1.726048"
 

Author: Anthony Scemama

-

Created: 2021-01-27 Wed 23:44

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/docs/perturbation.html b/docs/perturbation.html index cc52cab..542284f 100644 --- a/docs/perturbation.html +++ b/docs/perturbation.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Perturbation @@ -250,31 +250,31 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summmary

+
+

1 Summary

-
-

2 MP2

+
+

2 MP2

-
-

2.1 Type

+
+

2.1 Type

type t
@@ -283,8 +283,8 @@ org_html_manager.setup();  // activate after the parameters are set
 
-
-

2.2 Creation

+
+

2.2 Creation

val make : frozen_core:Mo.Frozen_core.t -> Mo.Basis.t -> t
@@ -307,7 +307,7 @@ org_html_manager.setup();  // activate after the parameters are set
 
 
 
-
+
 let mp2 =
   Perturbation.Mp2.make ~frozen_core:(Mo.Frozen_core.(make Small nuclei)) mo_basis
   ;;
@@ -316,8 +316,8 @@ val mp2 : Perturbation.Mp2.t = E(MP2)=-0.185523
 
-
-

2.3 Access

+
+

2.3 Access

val energy      : t -> float
@@ -352,14 +352,14 @@ val mp2 : Perturbation.Mp2.t = E(MP2)=-0.185523
 
 
 
-
+
 
 
-
-

2.4 Printers

+
+

2.4 Printers

val pp : Format.formatter -> t -> unit
@@ -368,14 +368,14 @@ val mp2 : Perturbation.Mp2.t = E(MP2)=-0.185523
 
-
-

2.5 Tests

+
+

2.5 Tests

Author: Anthony Scemama

-

Created: 2021-01-27 Wed 23:44

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/docs/top.html b/docs/top.html index 94b59bb..eae2012 100644 --- a/docs/top.html +++ b/docs/top.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Top-level @@ -250,18 +250,18 @@ org_html_manager.setup(); // activate after the parameters are set

Table of Contents

-
-

1 Summmary

+
+

1 Summary

Author: Anthony Scemama

-

Created: 2021-02-03 Wed 10:47

+

Created: 2021-10-19 Tue 16:20

Validate

diff --git a/gaussian/README.org b/gaussian/README.org index 0ca7516..f7fea5b 100644 --- a/gaussian/README.org +++ b/gaussian/README.org @@ -1,7 +1,7 @@ #+TITLE: Gaussian #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/gaussian_integrals/README.org b/gaussian_integrals/README.org index 3391f2a..a124315 100644 --- a/gaussian_integrals/README.org +++ b/gaussian_integrals/README.org @@ -1,7 +1,7 @@ #+TITLE: Gaussian integrals #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/linear_algebra/README.org b/linear_algebra/README.org index 7bcc625..6027477 100644 --- a/linear_algebra/README.org +++ b/linear_algebra/README.org @@ -1,7 +1,7 @@ #+TITLE: Linear Algebra #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/mo/README.org b/mo/README.org index 20afbd0..00a6415 100644 --- a/mo/README.org +++ b/mo/README.org @@ -1,7 +1,7 @@ #+TITLE: Molecular orbitals #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/operators/README.org b/operators/README.org index 20ebe15..ad32ce6 100644 --- a/operators/README.org +++ b/operators/README.org @@ -1,7 +1,7 @@ #+TITLE: Operators #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/particles/README.org b/particles/README.org index 885a59d..92d27ab 100644 --- a/particles/README.org +++ b/particles/README.org @@ -1,7 +1,7 @@ #+TITLE: Common #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/perturbation/README.org b/perturbation/README.org index 55a6c86..7ba9d96 100644 --- a/perturbation/README.org +++ b/perturbation/README.org @@ -1,7 +1,7 @@ #+TITLE: Perturbation #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/qcaml/README.org b/qcaml/README.org index 84dde9b..87e1e8e 100644 --- a/qcaml/README.org +++ b/qcaml/README.org @@ -1,7 +1,7 @@ #+TITLE: QCaml #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/simulation/README.org b/simulation/README.org index 89904dc..fed3419 100644 --- a/simulation/README.org +++ b/simulation/README.org @@ -1,7 +1,7 @@ #+TITLE: Simulation #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value diff --git a/top/README.org b/top/README.org index 073ef58..850a802 100644 --- a/top/README.org +++ b/top/README.org @@ -1,7 +1,7 @@ #+TITLE: Top-level #+SETUPFILE: ../docs/theme.setup -* Summmary +* Summary #+name: synopsis #+begin_src ocaml :exports none :results value