Skip to content

Commit

Permalink
doc cleanup (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
0x00b1 authored Jul 10, 2024
1 parent 438eb1d commit f309427
Show file tree
Hide file tree
Showing 35 changed files with 298 additions and 324 deletions.
18 changes: 0 additions & 18 deletions docs/beignet.datasets.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/beignet.special.md

This file was deleted.

279 changes: 1 addition & 278 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,278 +1 @@
# Operators

## Geometry

### Euler Angle

::: beignet.apply_euler_angle
::: beignet.compose_euler_angle
::: beignet.euler_angle_identity
::: beignet.euler_angle_magnitude
::: beignet.euler_angle_mean
::: beignet.euler_angle_to_quaternion
::: beignet.euler_angle_to_rotation_matrix
::: beignet.euler_angle_to_rotation_vector
::: beignet.invert_euler_angle
::: beignet.random_euler_angle

### Quaternion

::: beignet.apply_quaternion
::: beignet.compose_quaternion
::: beignet.invert_quaternion
::: beignet.quaternion_identity
::: beignet.quaternion_magnitude
::: beignet.quaternion_mean
::: beignet.quaternion_slerp
::: beignet.quaternion_to_euler_angle
::: beignet.quaternion_to_rotation_matrix
::: beignet.quaternion_to_rotation_vector
::: beignet.random_quaternion

### Rotation Matrix

::: beignet.apply_rotation_matrix
::: beignet.compose_rotation_matrix
::: beignet.invert_rotation_matrix
::: beignet.random_rotation_matrix
::: beignet.rotation_matrix_identity
::: beignet.rotation_matrix_magnitude
::: beignet.rotation_matrix_mean
::: beignet.rotation_matrix_to_euler_angle
::: beignet.rotation_matrix_to_quaternion
::: beignet.rotation_matrix_to_rotation_vector

### Rotation Vector

::: beignet.apply_rotation_vector
::: beignet.compose_rotation_vector
::: beignet.invert_rotation_vector
::: beignet.random_rotation_vector
::: beignet.rotation_vector_identity
::: beignet.rotation_vector_magnitude
::: beignet.rotation_vector_mean
::: beignet.rotation_vector_to_euler_angle
::: beignet.rotation_vector_to_quaternion
::: beignet.rotation_vector_to_rotation_matrix

### Translation

::: beignet.translation_identity

### Transform

::: beignet.apply_transform
::: beignet.invert_transform

## Interpolation

## Numerical Integration

### Gaussian Quadrature

::: beignet.gauss_laguerre_quadrature
::: beignet.gauss_legendre_quadrature
::: beignet.gauss_physicists_hermite_polynomial_quadrature
::: beignet.gauss_probabilists_hermite_polynomial_quadrature

## Polynomials

### Polynomial

::: beignet.add_polynomial
::: beignet.differentiate_polynomial
::: beignet.divide_polynomial
::: beignet.evaluate_polynomial
::: beignet.evaluate_polynomial_2d
::: beignet.evaluate_polynomial_3d
::: beignet.evaluate_polynomial_cartesian_2d
::: beignet.evaluate_polynomial_cartesian_3d
::: beignet.evaluate_polynomial_from_roots
::: beignet.fit_polynomial
::: beignet.integrate_polynomial
::: beignet.linear_polynomial
::: beignet.multiply_polynomial
::: beignet.multiply_polynomial_by_x
::: beignet.polynomial_companion
::: beignet.polynomial_domain
::: beignet.polynomial_from_roots
::: beignet.polynomial_one
::: beignet.polynomial_power
::: beignet.polynomial_roots
::: beignet.polynomial_to_chebyshev_polynomial
::: beignet.polynomial_to_laguerre_polynomial
::: beignet.polynomial_to_legendre_polynomial
::: beignet.polynomial_to_physicists_hermite_polynomial
::: beignet.polynomial_to_probabilists_hermite_polynomial
::: beignet.polynomial_vandermonde
::: beignet.polynomial_vandermonde_2d
::: beignet.polynomial_vandermonde_3d
::: beignet.polynomial_x
::: beignet.polynomial_zero
::: beignet.subtract_polynomial
::: beignet.trim_polynomial_coefficients

### Chebyshev Polynomial

::: beignet.add_chebyshev_polynomial
::: beignet.chebyshev_extrema
::: beignet.chebyshev_gauss_quadrature
::: beignet.chebyshev_interpolation
::: beignet.chebyshev_polynomial_companion
::: beignet.chebyshev_polynomial_domain
::: beignet.chebyshev_polynomial_from_roots
::: beignet.chebyshev_polynomial_one
::: beignet.chebyshev_polynomial_power
::: beignet.chebyshev_polynomial_roots
::: beignet.chebyshev_polynomial_to_polynomial
::: beignet.chebyshev_polynomial_vandermonde
::: beignet.chebyshev_polynomial_vandermonde_2d
::: beignet.chebyshev_polynomial_vandermonde_3d
::: beignet.chebyshev_polynomial_weight
::: beignet.chebyshev_polynomial_x
::: beignet.chebyshev_polynomial_zero
::: beignet.chebyshev_zeros
::: beignet.differentiate_chebyshev_polynomial
::: beignet.divide_chebyshev_polynomial
::: beignet.evaluate_chebyshev_polynomial
::: beignet.evaluate_chebyshev_polynomial_2d
::: beignet.evaluate_chebyshev_polynomial_3d
::: beignet.evaluate_chebyshev_polynomial_cartesian_2d
::: beignet.evaluate_chebyshev_polynomial_cartesian_3d
::: beignet.fit_chebyshev_polynomial
::: beignet.integrate_chebyshev_polynomial
::: beignet.linear_chebyshev_polynomial
::: beignet.multiply_chebyshev_polynomial
::: beignet.multiply_chebyshev_polynomial_by_x
::: beignet.subtract_chebyshev_polynomial
::: beignet.trim_chebyshev_polynomial_coefficients

### Laguerre Polynomial

::: beignet.add_laguerre_polynomial
::: beignet.differentiate_laguerre_polynomial
::: beignet.divide_laguerre_polynomial
::: beignet.evaluate_laguerre_polynomial
::: beignet.evaluate_laguerre_polynomial_2d
::: beignet.evaluate_laguerre_polynomial_3d
::: beignet.evaluate_laguerre_polynomial_cartesian_2d
::: beignet.evaluate_laguerre_polynomial_cartesian_3d
::: beignet.fit_laguerre_polynomial
::: beignet.integrate_laguerre_polynomial
::: beignet.laguerre_polynomial_companion
::: beignet.laguerre_polynomial_domain
::: beignet.laguerre_polynomial_from_roots
::: beignet.laguerre_polynomial_one
::: beignet.laguerre_polynomial_power
::: beignet.laguerre_polynomial_roots
::: beignet.laguerre_polynomial_to_polynomial
::: beignet.laguerre_polynomial_vandermonde
::: beignet.laguerre_polynomial_vandermonde_2d
::: beignet.laguerre_polynomial_vandermonde_3d
::: beignet.laguerre_polynomial_weight
::: beignet.laguerre_polynomial_x
::: beignet.laguerre_polynomial_zero
::: beignet.linear_laguerre_polynomial
::: beignet.multiply_laguerre_polynomial
::: beignet.multiply_laguerre_polynomial_by_x
::: beignet.subtract_laguerre_polynomial
::: beignet.trim_laguerre_polynomial_coefficients

### Legendre Polynomial

::: beignet.add_legendre_polynomial
::: beignet.differentiate_legendre_polynomial
::: beignet.divide_legendre_polynomial
::: beignet.evaluate_legendre_polynomial
::: beignet.evaluate_legendre_polynomial_2d
::: beignet.evaluate_legendre_polynomial_3d
::: beignet.evaluate_legendre_polynomial_cartesian_2d
::: beignet.evaluate_legendre_polynomial_cartesian_3d
::: beignet.fit_legendre_polynomial
::: beignet.integrate_legendre_polynomial
::: beignet.legendre_polynomial_companion
::: beignet.legendre_polynomial_domain
::: beignet.legendre_polynomial_from_roots
::: beignet.legendre_polynomial_one
::: beignet.legendre_polynomial_power
::: beignet.legendre_polynomial_roots
::: beignet.legendre_polynomial_to_polynomial
::: beignet.legendre_polynomial_vandermonde
::: beignet.legendre_polynomial_vandermonde_2d
::: beignet.legendre_polynomial_vandermonde_3d
::: beignet.legendre_polynomial_weight
::: beignet.legendre_polynomial_x
::: beignet.legendre_polynomial_zero
::: beignet.linear_legendre_polynomial
::: beignet.multiply_legendre_polynomial
::: beignet.multiply_legendre_polynomial_by_x
::: beignet.subtract_legendre_polynomial
::: beignet.trim_legendre_polynomial_coefficients

### Physicists’ Hermite Polynomial

::: beignet.add_physicists_hermite_polynomial
::: beignet.differentiate_physicists_hermite_polynomial
::: beignet.divide_physicists_hermite_polynomial
::: beignet.evaluate_physicists_hermite_polynomial
::: beignet.evaluate_physicists_hermite_polynomial_2d
::: beignet.evaluate_physicists_hermite_polynomial_3d
::: beignet.evaluate_physicists_hermite_polynomial_cartesian_2d
::: beignet.evaluate_physicists_hermite_polynomial_cartesian_3d
::: beignet.fit_physicists_hermite_polynomial
::: beignet.integrate_physicists_hermite_polynomial
::: beignet.linear_physicists_hermite_polynomial
::: beignet.multiply_physicists_hermite_polynomial
::: beignet.multiply_physicists_hermite_polynomial_by_x
::: beignet.physicists_hermite_polynomial_companion
::: beignet.physicists_hermite_polynomial_domain
::: beignet.physicists_hermite_polynomial_from_roots
::: beignet.physicists_hermite_polynomial_one
::: beignet.physicists_hermite_polynomial_power
::: beignet.physicists_hermite_polynomial_roots
::: beignet.physicists_hermite_polynomial_to_polynomial
::: beignet.physicists_hermite_polynomial_vandermonde
::: beignet.physicists_hermite_polynomial_vandermonde_2d
::: beignet.physicists_hermite_polynomial_vandermonde_3d
::: beignet.physicists_hermite_polynomial_weight
::: beignet.physicists_hermite_polynomial_x
::: beignet.physicists_hermite_polynomial_zero
::: beignet.subtract_physicists_hermite_polynomial
::: beignet.trim_physicists_hermite_polynomial_coefficients

### Probabilists’ Hermite Polynomial

::: beignet.add_probabilists_hermite_polynomial
::: beignet.differentiate_probabilists_hermite_polynomial
::: beignet.divide_probabilists_hermite_polynomial
::: beignet.evaluate_probabilists_hermite_polynomial
::: beignet.evaluate_probabilists_hermite_polynomial_2d
::: beignet.evaluate_probabilists_hermite_polynomial_3d
::: beignet.evaluate_probabilists_hermite_polynomial_cartersian_2d
::: beignet.evaluate_probabilists_hermite_polynomial_cartersian_3d
::: beignet.fit_probabilists_hermite_polynomial
::: beignet.integrate_probabilists_hermite_polynomial
::: beignet.linear_probabilists_hermite_polynomial
::: beignet.multiply_probabilists_hermite_polynomial
::: beignet.multiply_probabilists_hermite_polynomial_by_x
::: beignet.probabilists_hermite_polynomial_companion
::: beignet.probabilists_hermite_polynomial_domain
::: beignet.probabilists_hermite_polynomial_from_roots
::: beignet.probabilists_hermite_polynomial_one
::: beignet.probabilists_hermite_polynomial_power
::: beignet.probabilists_hermite_polynomial_roots
::: beignet.probabilists_hermite_polynomial_to_polynomial
::: beignet.probabilists_hermite_polynomial_vandermonde
::: beignet.probabilists_hermite_polynomial_vandermonde_2d
::: beignet.probabilists_hermite_polynomial_vandermonde_3d
::: beignet.probabilists_hermite_polynomial_weight
::: beignet.probabilists_hermite_polynomial_x
::: beignet.probabilists_hermite_polynomial_zero
::: beignet.subtract_probabilists_hermite_polynomial
::: beignet.trim_probabilists_hermite_polynomial_coefficients

## Thermodynamics

### Interatomic Potentials

::: beignet.lennard_jones_potential
# Beignet
Empty file added docs/installation.md
Empty file.
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/reference/datasets/geometry/transformations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
::: beignet.datasets.RandomEulerAngleDataset
::: beignet.datasets.RandomQuaternionDataset
::: beignet.datasets.RandomRotationMatrixDataset
::: beignet.datasets.RandomRotationVectorDataset
6 changes: 6 additions & 0 deletions docs/reference/datasets/protein-sequences.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
::: beignet.datasets.UniProtDataset
::: beignet.datasets.UniRef50Dataset
::: beignet.datasets.UniRef90Dataset
::: beignet.datasets.UniRef100Dataset
::: beignet.datasets.SwissProtDataset
::: beignet.datasets.TrEMBLDataset
3 changes: 3 additions & 0 deletions docs/reference/datasets/sequences.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
::: beignet.datasets.FASTADataset
::: beignet.datasets.SequenceDataset
::: beignet.datasets.SizedSequenceDataset
3 changes: 3 additions & 0 deletions docs/reference/datasets/trajectory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
::: beignet.datasets.TrajectoryDataset
::: beignet.datasets.HDF5TrajectoryDataset
::: beignet.datasets.PDBTrajectoryDataset
1 change: 1 addition & 0 deletions docs/reference/features/general-purpose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: beignet.features.Feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# beignet.features

::: beignet.features.Feature
::: beignet.features.EulerAngle
::: beignet.features.Quaternion
::: beignet.features.RotationMatrix
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# beignet.func

::: beignet.func.space
10 changes: 10 additions & 0 deletions docs/reference/operators/geometry/transformations/euler-angle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
::: beignet.apply_euler_angle
::: beignet.compose_euler_angle
::: beignet.euler_angle_identity
::: beignet.euler_angle_magnitude
::: beignet.euler_angle_mean
::: beignet.euler_angle_to_quaternion
::: beignet.euler_angle_to_rotation_matrix
::: beignet.euler_angle_to_rotation_vector
::: beignet.invert_euler_angle
::: beignet.random_euler_angle
11 changes: 11 additions & 0 deletions docs/reference/operators/geometry/transformations/quaternion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
::: beignet.apply_quaternion
::: beignet.compose_quaternion
::: beignet.invert_quaternion
::: beignet.quaternion_identity
::: beignet.quaternion_magnitude
::: beignet.quaternion_mean
::: beignet.quaternion_slerp
::: beignet.quaternion_to_euler_angle
::: beignet.quaternion_to_rotation_matrix
::: beignet.quaternion_to_rotation_vector
::: beignet.random_quaternion
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
::: beignet.apply_rotation_matrix
::: beignet.compose_rotation_matrix
::: beignet.invert_rotation_matrix
::: beignet.random_rotation_matrix
::: beignet.rotation_matrix_identity
::: beignet.rotation_matrix_magnitude
::: beignet.rotation_matrix_mean
::: beignet.rotation_matrix_to_euler_angle
::: beignet.rotation_matrix_to_quaternion
::: beignet.rotation_matrix_to_rotation_vector
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
::: beignet.apply_rotation_vector
::: beignet.compose_rotation_vector
::: beignet.invert_rotation_vector
::: beignet.random_rotation_vector
::: beignet.rotation_vector_identity
::: beignet.rotation_vector_magnitude
::: beignet.rotation_vector_mean
::: beignet.rotation_vector_to_euler_angle
::: beignet.rotation_vector_to_quaternion
::: beignet.rotation_vector_to_rotation_matrix
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
::: beignet.apply_transform
::: beignet.invert_transform
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: beignet.translation_identity
Empty file.
1 change: 1 addition & 0 deletions docs/reference/operators/interatomic-potentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: beignet.lennard_jones_potential
Loading

0 comments on commit f309427

Please sign in to comment.