Beginning javadoc

This commit is contained in:
F. Y. H. 2023-05-23 23:28:58 +02:00
parent 7ca0e4c33a
commit 5ce51347ec
Signed by: Alnotz
GPG key ID: B808CA1113935C00
8 changed files with 30 additions and 0 deletions

View file

@ -1,5 +1,8 @@
package fr.alnotz.quaternion; package fr.alnotz.quaternion;
/**
* Classe du nombre dual, un couple de nombres réels direct et dual.
*/
public class Dual implements IsDual{ public class Dual implements IsDual{
private double r; private double r;
private double d; private double d;

View file

@ -1,5 +1,8 @@
package fr.alnotz.quaternion; package fr.alnotz.quaternion;
/**
* Classe du quaternion dual, combinaison entre dual et quaternion.
*/
public class DualQuaternion implements IsDualQuaternion { public class DualQuaternion implements IsDualQuaternion {
private double rs; private double rs;
private double ri; private double ri;

View file

@ -1,5 +1,8 @@
package fr.alnotz.quaternion; package fr.alnotz.quaternion;
/**
* Interface détiquette pour tout nombre dual.
*/
public interface IsDual { public interface IsDual {
double getR(); double getR();
double getD(); double getD();

View file

@ -1,5 +1,8 @@
package fr.alnotz.quaternion; package fr.alnotz.quaternion;
/**
* Interface détiquette pour tout nombre quaternionique et dual.
*/
public interface IsDualQuaternion { public interface IsDualQuaternion {
IsQuaternion getR(); IsQuaternion getR();
IsQuaternion getD(); IsQuaternion getD();

View file

@ -1,5 +1,8 @@
package fr.alnotz.quaternion; package fr.alnotz.quaternion;
/**
* Interface détiquette pour tout nombre quaternionique.
*/
public interface IsQuaternion { public interface IsQuaternion {
double getS(); double getS();
double getI(); double getI();

View file

@ -1,5 +1,9 @@
package fr.alnotz.quaternion; package fr.alnotz.quaternion;
/**
* Classe du quaternion, une combinaison de quatre nombres réels.
* $q = a + bi + cj + dk$
*/
public class Quaternion implements IsQuaternion{ public class Quaternion implements IsQuaternion{
private double s; private double s;
private double i; private double i;

View file

@ -0,0 +1,5 @@
/**
* Package dédié aux quaternions.
*/
package fr.alnotz.quaternion;

6
module-info.java Normal file
View file

@ -0,0 +1,6 @@
/**
* Module : "quaternion-java".
* Package principal : "fr.alnotz.quaternion"
*/
module quaternion.java {
}