NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | List of all members
nest::AbstractMask Class Referenceabstract

Abstract base class for masks with unspecified dimension. More...

#include <mask.h>

Inheritance diagram for nest::AbstractMask:
nest::GridMask< D > nest::Mask< D > nest::AllMask< D > nest::AnchoredMask< D > nest::BallMask< D > nest::BoxMask< D > nest::ConverseMask< D > nest::DifferenceMask< D > nest::IntersectionMask< D > nest::UnionMask< D >

Public Member Functions

virtual ~AbstractMask ()
 Virtual destructor. More...
 
virtual bool inside (const std::vector< double_t > &) const =0
 
virtual DictionaryDatum get_dict () const
 
virtual AbstractMaskintersect_mask (const AbstractMask &other) const =0
 Create the intersection of this mask with another. More...
 
virtual AbstractMaskunion_mask (const AbstractMask &other) const =0
 Create the union of this mask with another. More...
 
virtual AbstractMaskminus_mask (const AbstractMask &other) const =0
 Create the difference of this mask and another. More...
 

Detailed Description

Abstract base class for masks with unspecified dimension.

Constructor & Destructor Documentation

virtual nest::AbstractMask::~AbstractMask ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

virtual DictionaryDatum nest::AbstractMask::get_dict ( ) const
inlinevirtual
Returns
a dictionary with the definition for this mask.

Reimplemented in nest::AnchoredMask< D >, nest::BallMask< D >, nest::BoxMask< D >, and nest::GridMask< D >.

virtual bool nest::AbstractMask::inside ( const std::vector< double_t > &  ) const
pure virtual
Returns
true if point is inside mask.

Implemented in nest::Mask< D >, and nest::GridMask< D >.

virtual AbstractMask* nest::AbstractMask::intersect_mask ( const AbstractMask other) const
pure virtual

Create the intersection of this mask with another.

Masks must have the same dimension

Returns
a new dynamically allocated mask.

Implemented in nest::Mask< D >, and nest::GridMask< D >.

virtual AbstractMask* nest::AbstractMask::minus_mask ( const AbstractMask other) const
pure virtual

Create the difference of this mask and another.

Masks must have the same dimension.

Returns
a new dynamically allocated mask.

Implemented in nest::Mask< D >, and nest::GridMask< D >.

virtual AbstractMask* nest::AbstractMask::union_mask ( const AbstractMask other) const
pure virtual

Create the union of this mask with another.

Masks must have the same dimension.

Returns
a new dynamically allocated mask.

Implemented in nest::Mask< D >, and nest::GridMask< D >.


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