scatter 0.1.0
scatter::Point Class Reference

[brief description] More...

#include <Point.hpp>

Public Member Functions

 Point (const double &x, const double &y)
 constructor
 
const double & x () const
 return the x value
 
const double & y () const
 return the y value
 
Point operator- (const Point &point) const
 substract another Point
 
Point operator+ (const Point &point) const
 add another Point
 
Point operator* (const double &multiplier) const
 multiply this Point by the given value
 
Point operator/ (const double &value) const
 divide this Point by the given value
 

Detailed Description

[brief description]

[long description]

Constructor & Destructor Documentation

◆ Point()

scatter::Point::Point ( const double & x,
const double & y )

constructor

[long description]

Parameters
xx value
yy value

Member Function Documentation

◆ operator*()

Point scatter::Point::operator* ( const double & multiplier) const

multiply this Point by the given value

[long description]

Parameters
multipliervalue
Returns
this Point mulitplied by value

◆ operator+()

Point scatter::Point::operator+ ( const Point & point) const

add another Point

[long description]

Parameters
pointPoint
Returns
sum of this and the other Point

◆ operator-()

Point scatter::Point::operator- ( const Point & point) const

substract another Point

[long description]

Parameters
pointPoint
Returns
difference between this and the other Point

◆ operator/()

Point scatter::Point::operator/ ( const double & value) const

divide this Point by the given value

[long description]

Parameters
valuedivide value
Returns
this Point divided by value

◆ x()

const double & scatter::Point::x ( ) const

return the x value

[long description]

Returns
x value

◆ y()

const double & scatter::Point::y ( ) const

return the y value

[long description]

Returns
x value

The documentation for this class was generated from the following file: