diff --git a/docs/beignet.datasets.md b/docs/beignet.datasets.md deleted file mode 100644 index b0309be4b9..0000000000 --- a/docs/beignet.datasets.md +++ /dev/null @@ -1,18 +0,0 @@ -# beignet.datasets - -::: beignet.datasets.FASTADataset -::: beignet.datasets.HDF5TrajectoryDataset -::: beignet.datasets.PDBTrajectoryDataset -::: beignet.datasets.RandomEulerAngleDataset -::: beignet.datasets.RandomQuaternionDataset -::: beignet.datasets.RandomRotationMatrixDataset -::: beignet.datasets.RandomRotationVectorDataset -::: beignet.datasets.SequenceDataset -::: beignet.datasets.SizedSequenceDataset -::: beignet.datasets.SwissProtDataset -::: beignet.datasets.TrEMBLDataset -::: beignet.datasets.TrajectoryDataset -::: beignet.datasets.UniProtDataset -::: beignet.datasets.UniRef50Dataset -::: beignet.datasets.UniRef90Dataset -::: beignet.datasets.UniRef100Dataset diff --git a/docs/beignet.special.md b/docs/beignet.special.md deleted file mode 100644 index 074d5ab324..0000000000 --- a/docs/beignet.special.md +++ /dev/null @@ -1,12 +0,0 @@ -# beignet.special - -## Error and Related Functions - -::: beignet.special.error_erf -::: beignet.special.error_erfc -::: beignet.special.error_erfi - -## Dawson and Fresnel Integrals - -::: beignet.special.dawson_integral_f -::: beignet.special.faddeeva_w diff --git a/docs/index.md b/docs/index.md index 5935d0b3b3..67c53f8989 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/beignet.io.md b/docs/reference/beignet.io.md similarity index 100% rename from docs/beignet.io.md rename to docs/reference/beignet.io.md diff --git a/docs/reference/datasets/geometry/transformations.md b/docs/reference/datasets/geometry/transformations.md new file mode 100644 index 0000000000..741033fd05 --- /dev/null +++ b/docs/reference/datasets/geometry/transformations.md @@ -0,0 +1,4 @@ +::: beignet.datasets.RandomEulerAngleDataset +::: beignet.datasets.RandomQuaternionDataset +::: beignet.datasets.RandomRotationMatrixDataset +::: beignet.datasets.RandomRotationVectorDataset diff --git a/docs/reference/datasets/protein-sequences.md b/docs/reference/datasets/protein-sequences.md new file mode 100644 index 0000000000..4c108f1b38 --- /dev/null +++ b/docs/reference/datasets/protein-sequences.md @@ -0,0 +1,6 @@ +::: beignet.datasets.UniProtDataset +::: beignet.datasets.UniRef50Dataset +::: beignet.datasets.UniRef90Dataset +::: beignet.datasets.UniRef100Dataset +::: beignet.datasets.SwissProtDataset +::: beignet.datasets.TrEMBLDataset diff --git a/docs/reference/datasets/sequences.md b/docs/reference/datasets/sequences.md new file mode 100644 index 0000000000..8566583fc2 --- /dev/null +++ b/docs/reference/datasets/sequences.md @@ -0,0 +1,3 @@ +::: beignet.datasets.FASTADataset +::: beignet.datasets.SequenceDataset +::: beignet.datasets.SizedSequenceDataset diff --git a/docs/reference/datasets/trajectory.md b/docs/reference/datasets/trajectory.md new file mode 100644 index 0000000000..84f423a0eb --- /dev/null +++ b/docs/reference/datasets/trajectory.md @@ -0,0 +1,3 @@ +::: beignet.datasets.TrajectoryDataset +::: beignet.datasets.HDF5TrajectoryDataset +::: beignet.datasets.PDBTrajectoryDataset diff --git a/docs/reference/features/general-purpose.md b/docs/reference/features/general-purpose.md new file mode 100644 index 0000000000..08973e3a0f --- /dev/null +++ b/docs/reference/features/general-purpose.md @@ -0,0 +1 @@ +::: beignet.features.Feature diff --git a/docs/beignet.features.md b/docs/reference/features/geometry/transformations.md similarity index 73% rename from docs/beignet.features.md rename to docs/reference/features/geometry/transformations.md index 99b4de4403..83f6c61911 100644 --- a/docs/beignet.features.md +++ b/docs/reference/features/geometry/transformations.md @@ -1,6 +1,3 @@ -# beignet.features - -::: beignet.features.Feature ::: beignet.features.EulerAngle ::: beignet.features.Quaternion ::: beignet.features.RotationMatrix diff --git a/docs/beignet.func.md b/docs/reference/func/molecular-dynamics.md similarity index 58% rename from docs/beignet.func.md rename to docs/reference/func/molecular-dynamics.md index d1ce96093a..4610d2a39b 100644 --- a/docs/beignet.func.md +++ b/docs/reference/func/molecular-dynamics.md @@ -1,3 +1 @@ -# beignet.func - ::: beignet.func.space diff --git a/docs/reference/operators/geometry/transformations/euler-angle.md b/docs/reference/operators/geometry/transformations/euler-angle.md new file mode 100644 index 0000000000..dd271fa313 --- /dev/null +++ b/docs/reference/operators/geometry/transformations/euler-angle.md @@ -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 \ No newline at end of file diff --git a/docs/reference/operators/geometry/transformations/quaternion.md b/docs/reference/operators/geometry/transformations/quaternion.md new file mode 100644 index 0000000000..27fabf0f65 --- /dev/null +++ b/docs/reference/operators/geometry/transformations/quaternion.md @@ -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 diff --git a/docs/reference/operators/geometry/transformations/rotation-matrix.md b/docs/reference/operators/geometry/transformations/rotation-matrix.md new file mode 100644 index 0000000000..f850c601b8 --- /dev/null +++ b/docs/reference/operators/geometry/transformations/rotation-matrix.md @@ -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 diff --git a/docs/reference/operators/geometry/transformations/rotation-vector.md b/docs/reference/operators/geometry/transformations/rotation-vector.md new file mode 100644 index 0000000000..677315f344 --- /dev/null +++ b/docs/reference/operators/geometry/transformations/rotation-vector.md @@ -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 diff --git a/docs/reference/operators/geometry/transformations/transform.md b/docs/reference/operators/geometry/transformations/transform.md new file mode 100644 index 0000000000..9cb58177b0 --- /dev/null +++ b/docs/reference/operators/geometry/transformations/transform.md @@ -0,0 +1,2 @@ +::: beignet.apply_transform +::: beignet.invert_transform diff --git a/docs/reference/operators/geometry/transformations/translation.md b/docs/reference/operators/geometry/transformations/translation.md new file mode 100644 index 0000000000..a8445a2f39 --- /dev/null +++ b/docs/reference/operators/geometry/transformations/translation.md @@ -0,0 +1 @@ +::: beignet.translation_identity diff --git a/docs/reference/operators/integral-transforms.md b/docs/reference/operators/integral-transforms.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/reference/operators/interatomic-potentials.md b/docs/reference/operators/interatomic-potentials.md new file mode 100644 index 0000000000..90d9f71356 --- /dev/null +++ b/docs/reference/operators/interatomic-potentials.md @@ -0,0 +1 @@ +::: beignet.lennard_jones_potential diff --git a/docs/reference/operators/numerical-methods/numerical-integration.md b/docs/reference/operators/numerical-methods/numerical-integration.md new file mode 100644 index 0000000000..c71066292e --- /dev/null +++ b/docs/reference/operators/numerical-methods/numerical-integration.md @@ -0,0 +1,6 @@ +## Gaussian Quadrature + +::: beignet.gauss_laguerre_quadrature +::: beignet.gauss_legendre_quadrature +::: beignet.gauss_physicists_hermite_polynomial_quadrature +::: beignet.gauss_probabilists_hermite_polynomial_quadrature diff --git a/docs/reference/operators/special-functions/dawson-and-fresnel-integrals.md b/docs/reference/operators/special-functions/dawson-and-fresnel-integrals.md new file mode 100644 index 0000000000..f4b195fa47 --- /dev/null +++ b/docs/reference/operators/special-functions/dawson-and-fresnel-integrals.md @@ -0,0 +1,2 @@ +::: beignet.special.dawson_integral_f +::: beignet.special.faddeeva_w diff --git a/docs/reference/operators/special-functions/error-and-related-functions.md b/docs/reference/operators/special-functions/error-and-related-functions.md new file mode 100644 index 0000000000..f422e6b2cf --- /dev/null +++ b/docs/reference/operators/special-functions/error-and-related-functions.md @@ -0,0 +1,3 @@ +::: beignet.special.error_erf +::: beignet.special.error_erfc +::: beignet.special.error_erfi diff --git a/docs/reference/operators/special-functions/orthogonal-polynomials/chebyshev-polynomial.md b/docs/reference/operators/special-functions/orthogonal-polynomials/chebyshev-polynomial.md new file mode 100644 index 0000000000..138e980c91 --- /dev/null +++ b/docs/reference/operators/special-functions/orthogonal-polynomials/chebyshev-polynomial.md @@ -0,0 +1,32 @@ +::: 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 diff --git a/docs/reference/operators/special-functions/orthogonal-polynomials/laguerre-polynomial.md b/docs/reference/operators/special-functions/orthogonal-polynomials/laguerre-polynomial.md new file mode 100644 index 0000000000..847a56cd3a --- /dev/null +++ b/docs/reference/operators/special-functions/orthogonal-polynomials/laguerre-polynomial.md @@ -0,0 +1,28 @@ +::: 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 \ No newline at end of file diff --git a/docs/reference/operators/special-functions/orthogonal-polynomials/legendre-polynomial.md b/docs/reference/operators/special-functions/orthogonal-polynomials/legendre-polynomial.md new file mode 100644 index 0000000000..9f4149f91e --- /dev/null +++ b/docs/reference/operators/special-functions/orthogonal-polynomials/legendre-polynomial.md @@ -0,0 +1,28 @@ +::: 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 diff --git a/docs/reference/operators/special-functions/orthogonal-polynomials/orthogonal-polynomials.md b/docs/reference/operators/special-functions/orthogonal-polynomials/orthogonal-polynomials.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/reference/operators/special-functions/orthogonal-polynomials/physicists-hermite-polynomial.md b/docs/reference/operators/special-functions/orthogonal-polynomials/physicists-hermite-polynomial.md new file mode 100644 index 0000000000..e58e11946f --- /dev/null +++ b/docs/reference/operators/special-functions/orthogonal-polynomials/physicists-hermite-polynomial.md @@ -0,0 +1,28 @@ +::: 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 diff --git a/docs/reference/operators/special-functions/orthogonal-polynomials/polynomial.md b/docs/reference/operators/special-functions/orthogonal-polynomials/polynomial.md new file mode 100644 index 0000000000..3d21ed386c --- /dev/null +++ b/docs/reference/operators/special-functions/orthogonal-polynomials/polynomial.md @@ -0,0 +1,32 @@ +::: 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 diff --git a/docs/reference/operators/special-functions/orthogonal-polynomials/probabilists-hermite-polynomial.md b/docs/reference/operators/special-functions/orthogonal-polynomials/probabilists-hermite-polynomial.md new file mode 100644 index 0000000000..3f7d653614 --- /dev/null +++ b/docs/reference/operators/special-functions/orthogonal-polynomials/probabilists-hermite-polynomial.md @@ -0,0 +1,28 @@ +::: 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 diff --git a/docs/reference/operators/thermodynamics.md b/docs/reference/operators/thermodynamics.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/beignet.transforms.md b/docs/reference/transforms/general-purpose.md similarity index 74% rename from docs/beignet.transforms.md rename to docs/reference/transforms/general-purpose.md index 6358a88baa..e674ecd7c8 100644 --- a/docs/beignet.transforms.md +++ b/docs/reference/transforms/general-purpose.md @@ -1,4 +1,2 @@ -# beignet.transforms - -::: beignet.transforms.Lambda ::: beignet.transforms.Transform +::: beignet.transforms.Lambda diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index e69de29bb2..0dfd9b12d4 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -0,0 +1,3 @@ +.md-nav__list { + text-overflow: ellipsis; +} diff --git a/docs/tutorials.md b/docs/tutorials.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/mkdocs.yml b/mkdocs.yml index 2eaac0e318..6d72499eec 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,13 +8,47 @@ markdown_extensions: - pymdownx.arithmatex: generic: true nav: - - beignet: "index.md" - - beignet.datasets: "beignet.datasets.md" - - beignet.features: "beignet.features.md" - - beignet.func: "beignet.func.md" - - beignet.io: "beignet.io.md" - - beignet.special: "beignet.special.md" - - beignet.transforms: "beignet.transforms.md" + - "Installation": "installation.md" + - "Tutorials": "tutorials.md" + - "Reference": + - "beignet": + - "Geometry": + - "Transformations": + - "Euler angle": "reference/operators/geometry/transformations/euler-angle.md" + - "Quaternion": "reference/operators/geometry/transformations/quaternion.md" + - "Rotation matrix": "reference/operators/geometry/transformations/rotation-matrix.md" + - "Rotation vector": "reference/operators/geometry/transformations/rotation-vector.md" + - "Transform": "reference/operators/geometry/transformations/transform.md" + - "Translation": "reference/operators/geometry/transformations/translation.md" + - "Integral transforms": "reference/operators/integral-transforms.md" + - "Interatomic potentials": "reference/operators/interatomic-potentials.md" + - "Numerical methods": + - "Numerical integration": "reference/operators/numerical-methods/numerical-integration.md" + - "Special functions": + - "Dawson and Fresnel integrals": "reference/operators/special-functions/dawson-and-fresnel-integrals.md" + - "Error and related functions": "reference/operators/special-functions/error-and-related-functions.md" + - "Orthogonal polynomials": + - "Polynomial": "reference/operators/special-functions/orthogonal-polynomials/polynomial.md" + - "Chebyshev polynomial": "reference/operators/special-functions/orthogonal-polynomials/chebyshev-polynomial.md" + - "Physicists’ Hermite polynomial": "reference/operators/special-functions/orthogonal-polynomials/physicists-hermite-polynomial.md" + - "Probabilists’ Hermite polynomial": "reference/operators/special-functions/orthogonal-polynomials/probabilists-hermite-polynomial.md" + - "Laguerre polynomial": "reference/operators/special-functions/orthogonal-polynomials/laguerre-polynomial.md" + - "Legendre polynomial": "reference/operators/special-functions/orthogonal-polynomials/legendre-polynomial.md" + - "Thermodynamics": "reference/reference/operators/thermodynamics.md" + - "beignet.datasets": + - "Geometry": + - "Transformations": "reference/datasets/geometry/transformations.md" + - "Protein sequences": "reference/datasets/protein-sequences.md" + - "Sequences": "reference/datasets/sequences.md" + - "beignet.features": + - "General-purpose": "reference/features/general-purpose.md" + - "Geometry": + - "Transformations": "reference/features/geometry/transformations.md" + - "beignet.func": + - "Molecular dynamics": "reference/func/molecular-dynamics.md" + - "beignet.io": "reference/operators.io.md" + - "beignet.transforms": + - "General-purpose": "reference/transforms/general-purpose.md" plugins: - mkdocstrings: default_handler: "python" @@ -28,4 +62,6 @@ plugins: show_source: true site_name: "Beignet" theme: - name: "material" \ No newline at end of file + features: + - "navigation.sections" + name: "material"