Verified Commit f086903f authored by Romain De Laage De Bellefaye's avatar Romain De Laage De Bellefaye 🌳
Browse files

Doc on Coordonnees

parent f872a181
Pipeline #79796 passed with stage
in 17 seconds
#ifndef COORDONNEES_H #ifndef COORDONNEES_H
#define COORDONNEES_H #define COORDONNEES_H
//on définit ici une structure Coordonnees permettant de décrire les coordonnées d'une cellule /// Structure de Coordonnees permettant de décrire les coordonnées d'une cellule
//etant donné que notre grille est en 2D, on a donc deux coordonnées x et y ///
/// etant donné que notre grille est en 2D, on a donc deux coordonnées x et y
struct Coordonnees //peu d'intérêt de définir une classe pour qq chose de si simple, une structure fait l'affaire /// peu d'intérêt de définir une classe pour qq chose de si simple, une structure fait l'affaire
struct Coordonnees
{ {
int x; //abscisse /// Abscisse de la Coordonnees
int y; //ordonnée int x;
/// Ordonnées de la Coordonnees
int y;
}; };
inline bool operator==(const Coordonnees& gauche, const Coordonnees& droite) { //test de l'égalité entre deux coordonnées /// Test de l'égalité entre deux Coordonnees
return gauche.x == droite.x && gauche.y == droite.y; /// @param[in] gauche Coordonnees 1 de l'assertion
/// @param[in] droite Coordonnees 2 de l'assertion
inline bool operator==(const Coordonnees& gauche, const Coordonnees& droite) {
return gauche.x == droite.x && gauche.y == droite.y;
} }
inline bool operator!=(const Coordonnees& gauche, const Coordonnees& droite) { //test si deux coordonnées sont différentes /// Test si deux coordonnées sont différentes
return !(gauche == droite); /// @param[in] gauche Coordonnees 1 de l'assertion
/// @param[in] droite Coordonnees 2 de l'assertion
inline bool operator!=(const Coordonnees& gauche, const Coordonnees& droite) {
return !(gauche == droite);
} }
inline Coordonnees operator+(const Coordonnees& gauche, const Coordonnees& droite) { //opération d'addition entre deux coordonnées /// Opération d'addition entre deux coordonnées
return {gauche.x + droite.x, gauche.y + droite.y}; /// @param[in] gauche Coordonnees 1 de l'opération
/// @param[in] droite Coordonnees 2 de l'opération
inline Coordonnees operator+(const Coordonnees& gauche, const Coordonnees& droite) {
return {gauche.x + droite.x, gauche.y + droite.y};
} }
inline Coordonnees operator-(const Coordonnees& gauche, const Coordonnees& droite) { //opération de soustraction entre deux coordonnées /// Opération de soustraction entre deux coordonnées
return {gauche.x - droite.x, gauche.y - droite.y}; /// @param[in] gauche Coordonnees 1 de l'opération
/// @param[in] droite Coordonnees 2 de l'opération
inline Coordonnees operator-(const Coordonnees& gauche, const Coordonnees& droite) {
return {gauche.x - droite.x, gauche.y - droite.y};
} }
#endif // COORDONNEES_H #endif // COORDONNEES_H
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment