DGtal::concepts::CDigitalBoundedShape< TShape > Struct Template Reference

Aim: designs the concept of bounded shapes in DGtal (shape for which upper and lower bounding bounds are available). More...

#include <DGtal/shapes/CDigitalBoundedShape.h>

Public Types
typedef TShape::Point	Point

Public Member Functions
	BOOST_CONCEPT_USAGE (CDigitalBoundedShape)

Private Attributes
TShape	myT
Point	myP

Detailed Description

template<typename TShape>
struct DGtal::concepts::CDigitalBoundedShape< TShape >

Aim: designs the concept of bounded shapes in DGtal (shape for which upper and lower bounding bounds are available).

DescriptionDescription of concept 'CDigitalBoundedShape'

Refinement of

Associated types

• Point: type for points (to characterize upper/lower bounds).

Notation

• X : A type that is a model of CDigitalBoundedShape
• x, y : Object of type X

Definitions

Valid expressions and semantics

| Name | Expression | Type requirements | Return type | Precondition | Semantics | Post condition | Complexity | |------------—|---------—|------------------—|----------—|---------------—|--------—|-------------—|---------—| |Lower bound | x.getLowerBound()| | |Point | |compute and return the lower bound of the shape bounding box | | | |Upper bound | x.getUpperBound()| | |Point | |compute and return the upper bound of the shape bounding box | | |

Invariants

Models

Implicit and Parametric shapes of the shape factory.

Notes

Definition at line 90 of file CDigitalBoundedShape.h.

Member Typedef Documentation

Point

template<typename TShape >

typedef TShape::Point DGtal::concepts::CDigitalBoundedShape< TShape >::Point

Definition at line 95 of file CDigitalBoundedShape.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename TShape >

DGtal::concepts::CDigitalBoundedShape< TShape >::BOOST_CONCEPT_USAGE ( CDigitalBoundedShape< TShape > )

inline

Definition at line 97 of file CDigitalBoundedShape.h.

    {
      // Shape should have a getUpperBound() returning a Point.
      ConceptUtils::sameType( myP, myT.getUpperBound() );
      // Shape should have a getLowerBound() returning a Point.
      ConceptUtils::sameType( myP, myT.getLowerBound() );    
    }

References DGtal::concepts::CDigitalBoundedShape< TShape >::myP, DGtal::concepts::CDigitalBoundedShape< TShape >::myT, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

myP

template<typename TShape >

Point DGtal::concepts::CDigitalBoundedShape< TShape >::myP

private

Definition at line 108 of file CDigitalBoundedShape.h.

Referenced by DGtal::concepts::CDigitalBoundedShape< TShape >::BOOST_CONCEPT_USAGE().

myT

template<typename TShape >

TShape DGtal::concepts::CDigitalBoundedShape< TShape >::myT

private

Definition at line 107 of file CDigitalBoundedShape.h.

Referenced by DGtal::concepts::CDigitalBoundedShape< TShape >::BOOST_CONCEPT_USAGE().

---

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

• CDigitalBoundedShape.h