AngouriMath.Core.FiniteSetBuilder Class Reference

Use this class for solvers and other places when a set needs to be built and you want to avoid using lists. More...

Public Member Functions
	FiniteSetBuilder ()
	Creates an instance of FiniteSetBuilder with no elements. More...
	FiniteSetBuilder (IEnumerable< Entity > elements)
	Creates an instance of FiniteSetBuilder with elements, provided in the argument. More...
void	Add (Entity element)
	It does not check for uniqueness of elements, however, it will be performed automatically once you will call the ToFiniteSet method. More...
void	Remove (Entity element)
	Removes a given element from the builder More...
FiniteSet	ToFiniteSet ()
	Build itself into a FiniteSet entity. More...

Public Attributes
bool	IsEmpty => raw.Count == 0
	Checks whether the number of elements added to the builder is zero More...

Detailed Description

Use this class for solvers and other places when a set needs to be built and you want to avoid using lists.

It builds an instance of FiniteSet.

Constructor & Destructor Documentation

FiniteSetBuilder() [1/2]

AngouriMath.Core.FiniteSetBuilder.FiniteSetBuilder ( )

inline

Creates an instance of FiniteSetBuilder with no elements.

FiniteSetBuilder() [2/2]

AngouriMath.Core.FiniteSetBuilder.FiniteSetBuilder ( IEnumerable< Entity >  elements )

inline

Creates an instance of FiniteSetBuilder with elements, provided in the argument.

It does not check for uniqueness of elements, however, it will be performed automatically once you will call the ToFiniteSet method.

Member Function Documentation

Add()

void AngouriMath.Core.FiniteSetBuilder.Add

(

Entity

element

)

It does not check for uniqueness of elements, however, it will be performed automatically once you will call the ToFiniteSet method.

Remove()

void AngouriMath.Core.FiniteSetBuilder.Remove

(

Entity

element

)

Removes a given element from the builder

Parameters

element

The element to remove. If no such element was found, method silently exits.

ToFiniteSet()

FiniteSet AngouriMath.Core.FiniteSetBuilder.ToFiniteSet

(

)

Build itself into a FiniteSet entity.

This method can be called multiple times throughout its lifetime.

var builder = new FiniteSetBuilder();
Console.WriteLine(builder.ToFiniteSet());
builder.Add(3);
Console.WriteLine(builder.ToFiniteSet());
builder.Add(4);
Console.WriteLine(builder.ToFiniteSet());
builder.Add(5);
Console.WriteLine(builder.ToFiniteSet());

Returns

An immutable FiniteSet entity.

Member Data Documentation

IsEmpty

bool AngouriMath.Core.FiniteSetBuilder.IsEmpty => raw.Count == 0

Checks whether the number of elements added to the builder is zero

---

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

• Sources/AngouriMath/Core/FiniteSetBuilder.cs