Circle Class Reference

Class representing a circle. More...

#include <cvb/circle.hpp>

Public Member Functions
	Circle () noexcept=default
	Create default circle.
	Circle (Point2D< double > center, double radius) noexcept
	Create a circle.
Point2D< double >	Center () const noexcept
	Gets the center of the circle.
void	SetCenter (Point2D< double > center) noexcept
	Sets the center of the circle.
double	Radius () const noexcept
	Gets the radius of the circle.
void	SetRadius (double radius) noexcept
	Sets the radius of the circle.
bool	Contains (Point2D< double > point) const noexcept
	Check whether a point is inside or outside a circle.
bool	IsOnRadius (Point2D< double > point, double epsilon) const noexcept
	Check whether a point is on the radius of a circle.
bool	operator== (const Circle &circle) const noexcept
	Compares to an other circle.
bool	operator!= (const Circle &circle) const noexcept
	Compares to an other circle.

Detailed Description

Class representing a circle.

For the purpose of regression and other calculations.

Constructor & Destructor Documentation

Circle() [1/2]

Circle ( )

defaultnoexcept

Create default circle.

All members are zero, so the circle is invalid!

Circle() [2/2]

Circle ( Point2D< double > center, double radius )

inlinenoexcept

Create a circle.

Parameters

[in]	center	Center of the circle.
[in]	radius	Radius of the circle.

Exceptions

Does	not throw any exception.

Member Function Documentation

Center()

Point2D< double > Center ( ) const

inlinenoexcept

Gets the center of the circle.

Returns

The center.

Exceptions

Does	not throw any exception.

Contains()

bool Contains ( Point2D< double > point ) const

inlinenoexcept

Check whether a point is inside or outside a circle.

Parameters

[in]

point

Point to be checked.

Returns

bool True if the point is inside the circle, false otherwise.

Exceptions

Does	not throw any exception.

IsOnRadius()

bool IsOnRadius ( Point2D< double > point, double epsilon ) const

inlinenoexcept

Check whether a point is on the radius of a circle.

Parameters

[in]	point	Point to be checked.
[in]	epsilon	Maximum allowable deviation.

Returns

True if the point lies within the allowable deviation of the circle's radius, false otherwise.

Exceptions

Does	not throw any exception.

operator!=()

bool operator!= ( const Circle & circle ) const

inlinenoexcept

Compares to an other circle.

Parameters

[in]

circle

Other circle.

Returns

True if not equal, otherwise false.

Exceptions

Does	not throw any exception.

operator==()

bool operator== ( const Circle & circle ) const

inlinenoexcept

Compares to an other circle.

Parameters

[in]

circle

Other circle.

Returns

True if equal, otherwise false.

Exceptions

Does	not throw any exception.

Radius()

double Radius ( ) const

inlinenoexcept

Gets the radius of the circle.

Returns

The radius.

Exceptions

Does	not throw any exception.

SetCenter()

void SetCenter ( Point2D< double > center )

inlinenoexcept

Sets the center of the circle.

Parameters

[in]

center

The new center.

Exceptions

Does	not throw any exception.

SetRadius()

void SetRadius ( double radius )

inlinenoexcept

Sets the radius of the circle.

Parameters

[in]

radius

If the radius is negative, the absolute value is used.

Exceptions

Does	not throw any exception.