Semantica.Lib.Intervals 8.1.0-beta

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of Semantica.Lib.Intervals. 
dotnet add package Semantica.Lib.Intervals --version 8.1.0-beta
                    


                    

                
NuGet\Install-Package Semantica.Lib.Intervals -Version 8.1.0-beta
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Semantica.Lib.Intervals" Version="8.1.0-beta" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Semantica.Lib.Intervals" Version="8.1.0-beta" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Semantica.Lib.Intervals" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Semantica.Lib.Intervals --version 8.1.0-beta
                    


                    

                
#r "nuget: Semantica.Lib.Intervals, 8.1.0-beta"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Semantica.Lib.Intervals@8.1.0-beta
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Semantica.Lib.Intervals&version=8.1.0-beta&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Semantica.Lib.Intervals&version=8.1.0-beta&prerelease
                    


                            Install as a Cake Tool

Semantica.Lib.Intervals

This package is part of the core packages of Semantica.Lib.

Summary

A library that provides types that can be used to represent intervals and collections of intervals as well as extensions for these types.

Dependencies

  • Semantica.Lib.Core
  • Semantica.Lib.Linq
  • Semantica.Lib.Patterns

Documentation generated from the XMLDoc:

<a name='assembly'></a>

Lib.Intervals

Contents

<a name='T-Semantica-Intervals-EmptyUnbindsInterval`1'></a>

EmptyUnbindsInterval`1 type

Namespace

Semantica.Intervals

Summary

Inherit from parent.

Summary

A class implementing IInterval`1, where the bounds implement ICanBeEmpty, where if calling IsEmpty for a bound returns true, that bound is considered unbounded.

<a name='T-Semantica-Intervals-IIntervalDictionary`2'></a>

IIntervalDictionary`2 type

Namespace

Semantica.Intervals

Summary

Inherit from parent.

Summary

A generic collection of IReadOnlyInterval`1 of keys and associated values. Intervals are not allowed to overlap.

<a name='T-Semantica-Intervals-IIntervalDictionary`3'></a>

IIntervalDictionary`3 type

Namespace

Semantica.Intervals

Summary

Inherit from parent.

Summary

A generic collection of intervals of keys and associated values. Intervals are not allowed to overlap.

<a name='P-Semantica-Intervals-IIntervalDictionary3-Item-1-'></a>

Item property

Summary

get: Searches the dictionary for the exact provided interval and returns the associated value.

set: If the exact provided interval is present in the dictionary the currently associated value is replaced by value. Tries to adds the interval and value otherwise. Throws if interval partly overlaps with an existing interval.

Returns

Value associated with the interval.

Parameters
Name Type Description
interval `1 Interval to search for.
Exceptions
Name Description
System.Collections.Generic.KeyNotFoundException Throws on get if interval is not present in the dictionary.
System.ArgumentException Throws on set if interval partly overlaps with any existing interval.

<a name='M-Semantica-Intervals-IIntervalDictionary3-Add-1,`2-'></a>

Add(keyInterval,value) method

Summary

Adds an element to the dictionary consisting of the specified key interval and associated value, but only if the interval does not overlap with a key interval already in the dictionary.

Returns

true if the element is added; false if keyInterval overlaps with any of the key intervals already in the dictionary.

Parameters
Name Type Description
keyInterval `1 The interval of keys associated with the value to add.
value `2 The value to add.

<a name='M-Semantica-Intervals-IIntervalDictionary3-Contains-1-'></a>

Contains(interval) method

Summary

Determines whether the dictionary contains en element with the exact provided interval.

Returns

true if the dictionary contains the exact interval.

Parameters
Name Type Description
interval `1 Interval to search for.

<a name='M-Semantica-Intervals-IIntervalDictionary3-TryGet-0,`2@-'></a>

TryGet(key,value) method

Summary

Searches for an interval containing key and returns the associated TValue value as out parameter value.

Returns

true if the dictionary contains an interval has key within it.

Parameters
Name Type Description
key `0 The key to locate the value for.
value `2@ Value associated with the key; or default if not found.

<a name='M-Semantica-Intervals-IIntervalDictionary3-TryGetInterval-0,`1@-'></a>

TryGetInterval(key,interval) method

Summary

Searches for an interval containing key and returns it as out parameter interval.

Returns

true if the dictionary contains an interval has key within it.

Parameters
Name Type Description
key `0 The key to locate the value for.
interval `1@ Out parameter containing the found interval, or default if not found.

<a name='T-Semantica-Intervals-IInterval`1'></a>

IInterval`1 type

Namespace

Semantica.Intervals

Summary

Inherit from parent.

<a name='T-Semantica-Intervals-IReadOnlyIntervalDictionary`2'></a>

IReadOnlyIntervalDictionary`2 type

Namespace

Semantica.Intervals

Summary

A generic read-only collection of IInterval`1 of keys and associated values. Intervals are not allowed to overlap.

Generic Types
Name Description
TKey Type of keys and the bounds of the intervals.
TValue Type of values stored in the dictionary.

<a name='T-Semantica-Intervals-IReadOnlyIntervalDictionary`3'></a>

IReadOnlyIntervalDictionary`3 type

Namespace

Semantica.Intervals

Summary

A generic read-only collection of intervals of keys and associated values. Intervals are not allowed to overlap.

Generic Types
Name Description
TKey Type of keys and the bounds of the intervals.
TInterval Type of the intervals.
TValue Type of values stored in the dictionary.

<a name='P-Semantica-Intervals-IReadOnlyIntervalDictionary`3-Intervals'></a>

Intervals property

Summary

Collection of intervals in the dictionary in no specified order (typically in order they were added).

<a name='P-Semantica-Intervals-IReadOnlyIntervalDictionary3-Item-0-'></a>

Item property

Summary

Searches for an interval containing key and returns the associated TValue value.

Returns

Value associated with the key.

Parameters
Name Type Description
key `0 The key to locate the interval for.
Exceptions
Name Description
System.Collections.Generic.KeyNotFoundException Throws if key is not part of any interval.

<a name='P-Semantica-Intervals-IReadOnlyIntervalDictionary`3-Values'></a>

Values property

Summary

Collection of values in the dictionary in no specified order (typically in order they were added).

<a name='M-Semantica-Intervals-IReadOnlyIntervalDictionary3-Contains-0-'></a>

Contains(key) method

Summary

Determines whether the dictionary contains an interval that has the specified key within it.

Returns

true if in interval in dictionary contains key.

Parameters
Name Type Description
key `0 Key to search for.

<a name='M-Semantica-Intervals-IReadOnlyIntervalDictionary`3-IntervalsAscending'></a>

IntervalsAscending() method

Summary

Enumerates all intervals in the dictionary in ascending logical order of values.

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IReadOnlyIntervalDictionary`3-IntervalsDescending'></a>

IntervalsDescending() method

Summary

Enumerates all intervals in the dictionary in descending logical order of values.

Parameters

This method has no parameters.

<a name='T-Semantica-Intervals-IReadOnlyInterval`1'></a>

IReadOnlyInterval`1 type

Namespace

Semantica.Intervals

Summary

Represents an interval of values. The interval is considered empty if it has either no, or a single value (a degenerate interval).

Generic Types
Name Description
T Any IComparable`1 type.
Remarks

Implementations have to guarantee that Left is not greater than Right. Obviously, when T is not immutable this cannot be guaranteed after creation.

<a name='P-Semantica-Intervals-IReadOnlyInterval`1-BoundKind'></a>

BoundKind property

Summary

Indicates if the interval is fully bound, or left- and/or right-unbound.

Remarks

When a side is unbound, that boundary's property are never used for comparisons.

<a name='P-Semantica-Intervals-IReadOnlyInterval`1-Left'></a>

Left property

<a name='P-Semantica-Intervals-IReadOnlyInterval`1-OpenKind'></a>

OpenKind property

Summary

Indicates if the interval is closed on both sides, or left- and/or right-open.

<a name='P-Semantica-Intervals-IReadOnlyInterval`1-Right'></a>

Right property

<a name='M-Semantica-Intervals-IReadOnlyInterval`1-IsDegenerate'></a>

IsDegenerate() method

Summary

true if the interval has only a single element.

Parameters

This method has no parameters.

<a name='T-Semantica-Intervals-Interval'></a>

Interval type

Namespace

Semantica.Intervals

Summary

Provides static methods used with Interval`1 and IReadOnlyInterval`1.

<a name='M-Semantica-Intervals-Interval-DetermineBoundKind-System-Boolean,System-Boolean-'></a>

DetermineBoundKind(isLeftUnbound,isRightUnbound) method

Summary

Determines the appropriate IntervalBoundKind value from two boolean values indicating if a side is unbound.

Returns

IntervalBoundKind indicating an intervals bound/unbound value.

Parameters
Name Type Description
isLeftUnbound System.Boolean true if the left side is unbound.
isRightUnbound System.Boolean true if the right side is unbound.

<a name='M-Semantica-Intervals-Interval-DetermineDegenerateEmpty1-0,``0,Semantica-Intervals-IntervalOpenKind,Semantica-Intervals-IntervalBoundKind-'></a>

DetermineDegenerateEmpty``1(left,right,openKind,boundKind) method

Summary

Determines if parameter values would constitute an empty or degenerate interval.

Returns

A tuple (bool isDegenerate, bool isEmpty) with two values where true indicates if the interval would be degenerate or empty respectively. Both values can never be true.

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
right ``0 Right (upper) boundary of the interval.
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind indicating if any bounds are open.
boundKind Semantica.Intervals.IntervalBoundKind IntervalBoundKind indicating whether sides are bound or unbound.
Generic Types
Name Description
T Any IComparable`1 type.

<a name='M-Semantica-Intervals-Interval-DetermineOpenKind-System-Boolean,System-Boolean,Semantica-Intervals-IntervalBoundKind-'></a>

DetermineOpenKind(isLeftOpen,isRightOpen,boundKind) method

Summary

Determines the appropriate IntervalOpenKind value from two boolean values indicating if a bound is open. If a boundKind is provided, guarantees a side that is unbound is always open.

Returns

IntervalOpenKind indicating an intervals open/closed bounds.

Parameters
Name Type Description
isLeftOpen System.Boolean true if the left bound is open.
isRightOpen System.Boolean true if the right bound is open.
boundKind Semantica.Intervals.IntervalBoundKind Optional IntervalBoundKind.

<a name='M-Semantica-Intervals-Interval-Empty``1'></a>

Empty``1() method

Summary

Makes an empty Interval`1. Equivalent to using default.

Returns

An empty Interval`1.

Parameters

This method has no parameters.

Generic Types
Name Description
T Any IComparable`1 type.

<a name='M-Semantica-Intervals-Interval-Equals1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

Equals``1(x,y) method

Summary

Determines whether two intervals are equal.

Returns

true if the specified intervals are equal; false otherwise.

Parameters
Name Type Description
x Semantica.Intervals.IReadOnlyInterval{``0} The first IReadOnlyInterval`1 to compare.
y Semantica.Intervals.IReadOnlyInterval{``0} The second IReadOnlyInterval`1 to compare.
Generic Types
Name Description
T Any IComparable`1 type.

<a name='M-Semantica-Intervals-Interval-Guard1-0,``0,Semantica-Intervals-IntervalBoundKind-'></a>

Guard``1(left,right,boundKind) method

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
right ``0 Right (upper) boundary of the interval.
boundKind Semantica.Intervals.IntervalBoundKind IntervalBoundKind indicating whether sides are bound or unbound.
Generic Types
Name Description
T Any IComparable`1 type.
Exceptions
Name Description
System.ArgumentException Throws if Left is greater than Right.

<a name='M-Semantica-Intervals-Interval-MakeDegenerate1-0-'></a>

MakeDegenerate``1(degenerateValue) method

Summary

Constructs a degenerate interval.

Parameters
Name Type Description
degenerateValue ``0 Value used for both boundaries of the interval.
Generic Types
Name Description
T Any IComparable`1 type.

<a name='M-Semantica-Intervals-Interval-MakeHalfOpen1-0,``0-'></a>

MakeHalfOpen``1(left,right) method

Summary

Constructs a bound, half open interval (RightOpen).

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
right ``0 Right (upper) boundary of the interval.
Generic Types
Name Description
T Any IComparable`1 type.
Exceptions
Name Description
System.ArgumentException Throws if left is greater than right.
Remarks

If a side is unbound, that side's open flag will be ignored and it will always be open.

<a name='M-Semantica-Intervals-Interval-MakeHalfOpen1-0,0,System-Func{0,System-Boolean}-'></a>

MakeHalfOpen``1(left,right,unboundPredicate) method

Summary

Constructs a half open interval (RightOpen). Determines BoundKind by evaluating unboundPredicate for both bounds.

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
right ``0 Right (upper) boundary of the interval.
unboundPredicate System.Func{``0,System.Boolean} Function that is called for each bound to determine if it's unbound.
Generic Types
Name Description
T Any IComparable`1 type.
Exceptions
Name Description
System.ArgumentException Throws if left is greater than right.
Remarks

If a side is unbound, that side's open flag will be ignored and it will always be open.

<a name='M-Semantica-Intervals-Interval-MakeLeftUnbound1-0,Semantica-Intervals-IntervalOpenKind-'></a>

MakeLeftUnbound``1(right,openKind) method

Summary

Constructs an interval that is left unbound.

Parameters
Name Type Description
right ``0 Right (upper) boundary of the interval.
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind that can indivate if the right bound is closed.
Generic Types
Name Description
T Any IComparable`1 type.
Remarks

If a side is unbound, that side's open flag will be ignored and it will always be open.

<a name='M-Semantica-Intervals-Interval-MakeRightUnbound1-0,Semantica-Intervals-IntervalOpenKind-'></a>

MakeRightUnbound``1(left,openKind) method

Summary

Constructs an interval that is right unbound.

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind that can indivate if the right bound is closed.
Generic Types
Name Description
T Any IComparable`1 type.
Remarks

If a side is unbound, that side's open flag will be ignored and it will always be open.

<a name='M-Semantica-Intervals-Interval-Make1-0,``0,Semantica-Intervals-IntervalOpenKind,Semantica-Intervals-IntervalBoundKind-'></a>

Make``1(left,right,openKind,boundKind) method

Summary

Constructs an Interval. Degenerate and Empty flags will be determined using the bounds and kinds.

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
right ``0 Right (upper) boundary of the interval.
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind indicating if any bounds are open.
boundKind Semantica.Intervals.IntervalBoundKind IntervalBoundKind indicating whether sides are bound or unbound.
Generic Types
Name Description
T Any IComparable`1 type.
Exceptions
Name Description
System.ArgumentException Throws if left is greater than right.
Remarks

If a side is unbound, that side's open flag will be ignored and it will always be open.

<a name='M-Semantica-Intervals-Interval-Make1-0,0,Semantica-Intervals-IntervalOpenKind,System-Func{0,System-Boolean}-'></a>

Make``1(left,right,openKind,unboundPredicate) method

Summary

Constructs an interval. Degenerate and Empty flags will be determined using the bounds and kinds. Determines BoundKind by evaluating unboundPredicate for both bounds.

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
right ``0 Right (upper) boundary of the interval.
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind indicating if any bounds are open.
unboundPredicate System.Func{``0,System.Boolean} Function that is called for each bound to determine if it's unbound.
Generic Types
Name Description
T Any IComparable`1 type.
Exceptions
Name Description
System.ArgumentException Throws if left is greater than right.
Remarks

If a side is unbound, that side's open flag will be ignored and it will always be open.

<a name='M-Semantica-Intervals-Interval-ToStringTryFormat1-Semantica-Intervals-IReadOnlyInterval{0},System-String,System-IFormatProvider-'></a>

ToStringTryFormat``1(interval,format,formatProvider) method

Summary

Formats the value of the provided interval using the specified format, if bounds implement IFormattable.

Returns

A string representation of the interval, with formatted boundary values.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} The IReadOnlyInterval`1 to format.
format System.String The format to use. -or- A null reference to use the default format defined for the type of the IFormattable
implementation.
formatProvider System.IFormatProvider The provider to use to format the value. -or- A null reference to obtain the numeric format information from the current
locale setting of the operating system.
Generic Types
Name Description
T Any IComparable`1 type.
Remarks

If T does not implement IFormattable, default ToString is used.

<a name='M-Semantica-Intervals-Interval-ToString1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

ToString``1(interval) method

Summary

Formats the value of the provided interval.

Returns

A string representation of the interval.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} The IReadOnlyInterval`1 to format.
Generic Types
Name Description
T Any IComparable`1 type.

<a name='M-Semantica-Intervals-Interval-ToString1-Semantica-Intervals-IReadOnlyInterval{0},System-String,System-IFormatProvider-'></a>

ToString``1(interval,format,formatProvider) method

Summary

Formats the value of the provided interval using the specified format.

Returns

A string representation of the interval, with formatted boundary values.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} The IReadOnlyInterval`1 to format.
format System.String The format to use. -or- A null reference to use the default format defined for the type of the IFormattable
implementation.
formatProvider System.IFormatProvider The provider to use to format the value. -or- A null reference to obtain the numeric format information from the current
locale setting of the operating system.
Generic Types
Name Description
T Any IComparable`1, IFormattable type.

<a name='M-Semantica-Intervals-Interval-ToString1-0,``0,System-Boolean,Semantica-Intervals-IntervalOpenKind,Semantica-Intervals-IntervalBoundKind,System-String,System-IFormatProvider-'></a>

ToString``1(left,right,isEmpty,openKind,boundKind,format,formatProvider) method

Summary

Formats two value as an interval using the specified format.

Returns

A string representation of the interval.

Parameters
Name Type Description
left ``0 Left (lower) boundary of the interval.
right ``0 Right (upper) boundary of the interval.
isEmpty System.Boolean true if the interval is empty.
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind indicating if any bounds are open.
boundKind Semantica.Intervals.IntervalBoundKind IntervalBoundKind indicating if sides are bound or unbound.
format System.String The format to use. -or- A null reference to use the default format defined for the type of the IFormattable
implementation.
formatProvider System.IFormatProvider The provider to use to format the value. -or- A null reference to obtain the numeric format information from the current
locale setting of the operating system.
Generic Types
Name Description
T Any IComparable`1 type.

<a name='T-Semantica-Intervals-IntervalBase`1'></a>

IntervalBase`1 type

Namespace

Semantica.Intervals

Summary

Inherit from parent.

Summary

Base implementation of IInterval`1

<a name='M-Semantica-Intervals-IntervalBase1-#ctor-0,`0,Semantica-Intervals-IntervalBoundKind-'></a>

#ctor(left,right,boundKind) constructor

Parameters
Name Type Description
left `0 Left (lower) boundary of the interval.
right `0 Right (upper) boundary of the interval.
boundKind Semantica.Intervals.IntervalBoundKind The IntervalBoundKind used for guarding (not stored!).
Exceptions
Name Description
System.ArgumentException throws if left is greater than right.

<a name='M-Semantica-Intervals-IntervalBase1-#ctor-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

#ctor(interval) constructor

Summary

Does not do left-right comparison because it assumes that was done when interval was constructed.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{`0} Tuple with left and right values of type T.

<a name='M-Semantica-Intervals-IntervalBase1-#ctor-System-ValueTuple{0,`0}-'></a>

#ctor(interval) constructor

Summary

Does not do left-right comparison. Only use if order is already checked, or call Guard``1.

Parameters
Name Type Description
interval System.ValueTuple{`0,`0} Tuple with left and right values of type T.

<a name='P-Semantica-Intervals-IntervalBase`1-IsLeftOpen'></a>

IsLeftOpen property

Summary

true if the left bound is open; false if it's closed.

<a name='P-Semantica-Intervals-IntervalBase`1-IsLeftUnbound'></a>

IsLeftUnbound property

Summary

true if the left side is unbound; false if it's bound.

<a name='P-Semantica-Intervals-IntervalBase`1-IsRightOpen'></a>

IsRightOpen property

Summary

true if the right bound is open; false if it's closed.

<a name='P-Semantica-Intervals-IntervalBase`1-IsRightUnbound'></a>

IsRightUnbound property

Summary

true if the right side is unbound; false if it's bound.

<a name='P-Semantica-Intervals-IntervalBase`1-TypeName'></a>

TypeName property

<a name='T-Semantica-Intervals-IntervalBoundKind'></a>

IntervalBoundKind type

Namespace

Semantica.Intervals

Summary

A flags enum that can indicating if an interval is fully bound (default), or left- and/or right-unbound.

<a name='T-Semantica-Intervals-IntervalDictionaryExtensions'></a>

IntervalDictionaryExtensions type

Namespace

Semantica.Intervals

Summary

Provides extension methods for IReadOnlyIntervalDictionary`3.

<a name='M-Semantica-Intervals-IntervalDictionaryExtensions-GetIntervalWithLeft3-Semantica-Intervals-IReadOnlyIntervalDictionary{0,1,2},``0-'></a>

GetIntervalWithLeft``3(dictionary,left) method

Summary

Retrieves the interval from dictionary with Left equal to the provided key.

Returns

Interval with Left equal to left.

Parameters
Name Type Description
dictionary Semantica.Intervals.IReadOnlyIntervalDictionary{``0,``1,``2} Dictionary to search for intervals.
left ``0 Key to search for.
Generic Types
Name Description
TValue Type of values stored in the dictionary.
TKey Type of the bounds of the intervals.
TInterval Type of the intervals.
Remarks

Note that the interval is returned regardless of the key being within the interval (IntervalOpenKind).

<a name='M-Semantica-Intervals-IntervalDictionaryExtensions-TryGetIntervalWithLeft3-Semantica-Intervals-IReadOnlyIntervalDictionary{0,1,2},0,1@-'></a>

TryGetIntervalWithLeft``3(dictionary,left,interval) method

Summary

Searches dictionary for the interval with Left equal to the provided key.

Returns

true if such an interval is contained in the dictionary.

Parameters
Name Type Description
dictionary Semantica.Intervals.IReadOnlyIntervalDictionary{``0,``1,``2} Dictionary to search for intervals.
left ``0 Key to search for.
interval ``1@ Out parameter that contains the interval with Left equal to left if
found; default otherwise.
Generic Types
Name Description
TValue Type of values stored in the dictionary.
TKey Type of the bounds of the intervals.
TInterval Type of the intervals.
Remarks

Note that an interval will match regardless of the key being within the interval (IntervalOpenKind).

<a name='T-Semantica-Intervals-IntervalDictionary`2'></a>

IntervalDictionary`2 type

Namespace

Semantica.Intervals

Summary

Inherit from parent.

<a name='M-Semantica-Intervals-IntervalDictionary`2-#ctor'></a>

#ctor() constructor

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

<a name='M-Semantica-Intervals-IntervalDictionary2-#ctor-System-Collections-Generic-IEnumerable{System-Collections-Generic-KeyValuePair{Semantica-Intervals-IInterval{0},`1}}-'></a>

#ctor() constructor

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

<a name='M-Semantica-Intervals-IntervalDictionary2-#ctor-System-Collections-Generic-IEnumerable{System-ValueTuple{Semantica-Intervals-IInterval{0},`1}}-'></a>

#ctor() constructor

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

<a name='T-Semantica-Intervals-IntervalDictionary`3'></a>

IntervalDictionary`3 type

Namespace

Semantica.Intervals

Summary

Inherit from parent.

<a name='M-Semantica-Intervals-IntervalDictionary`3-#ctor'></a>

#ctor() constructor

Summary

Constructs an empty instance.

Parameters

This constructor has no parameters.

<a name='M-Semantica-Intervals-IntervalDictionary3-#ctor-System-Collections-Generic-IEnumerable{System-Collections-Generic-KeyValuePair{1,`2}}-'></a>

#ctor(pairs) constructor

Summary

Constucts an instance, adding all pairs of intervals and values.

Parameters
Name Type Description
pairs System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{`1,`2}} An IEnumerable`1 of KeyValuePair`2, where they keys are intervals.
Exceptions
Name Description
System.ArgumentException Throws if any of the intervals have a non-empty intersection.

<a name='M-Semantica-Intervals-IntervalDictionary3-#ctor-System-Collections-Generic-IEnumerable{System-ValueTuple{1,`2}}-'></a>

#ctor(tuples) constructor

Summary

Constucts an instance, adding all tuples of intervals and values.

Parameters
Name Type Description
tuples System.Collections.Generic.IEnumerable{System.ValueTuple{`1,`2}} An IEnumerable`1 of tuples of intervals and corresponding values.
Exceptions
Name Description
System.ArgumentException Throws if any of the intervals have a non-empty intersection.

<a name='T-Semantica-Intervals-IntervalEnumerationExtensions'></a>

IntervalEnumerationExtensions type

Namespace

Semantica.Intervals

Summary

Provides extension methods of various types of enumerations pertaining to intervals.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-Extend1-System-Collections-Generic-IEnumerable{Semantica-Intervals-EmptyUnbindsInterval{0}}-'></a>

Extend``1(intervals) method

Summary

Creates an EmptyUnbindsInterval`1 with the left (lower) bound taken from the minimal value in any of the input intervals, and the right (upper) bound taken from the maximal value in any of the input intervals.

Returns

New instance of EmptyUnbindsInterval`1 spanning all the values within any of the input intervals, and all values in between.

Parameters
Name Type Description
intervals System.Collections.Generic.IEnumerable{Semantica.Intervals.EmptyUnbindsInterval{``0}} An enumeration of intervals.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-Extend1-System-Collections-Generic-IEnumerable{Semantica-Intervals-Interval{0}}-'></a>

Extend``1(intervals) method

Summary

Creates an Interval`1 with the left (lower) bound taken from the minimal value in any of the input intervals, and the right (upper) bound taken from the maximal value in any of the input intervals.

Returns

New instance of Interval`1 spanning all the values within any of the input intervals, and all values in between.

Parameters
Name Type Description
intervals System.Collections.Generic.IEnumerable{Semantica.Intervals.Interval{``0}} An enumeration of intervals.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-Extend2-System-Collections-Generic-IEnumerable{1},System-Func{0,0,Semantica-Intervals-IntervalOpenKind,Semantica-Intervals-IntervalBoundKind,``1}-'></a>

Extend``2(intervals,factory) method

Summary

Creates an Interval`1 with the left (lower) bound taken from the minimal value in any of the input intervals, and the right (upper) bound taken from the maximal value in any of the input intervals.

Returns

New instance of Interval`1 spanning all the values within any of the input intervals, and all values in between.

Parameters
Name Type Description
intervals System.Collections.Generic.IEnumerable{``1} An enumeration of intervals.
factory System.Func{``0,``0,Semantica.Intervals.IntervalOpenKind,Semantica.Intervals.IntervalBoundKind,``1} A function that can create a new interval of the appropriate type.
Generic Types
Name Description
T Type of bounds of the intervals.
TInterval Type of intervals.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-ToIntervalDictionary2-System-Collections-Generic-IEnumerable{System-ValueTuple{Semantica-Intervals-IInterval{0},``1}}-'></a>

ToIntervalDictionary``2(enumerable) method

Summary

Creates a new IntervalDictionary`2 containing the intervals and values from the provided IEnumerable`1 of tuples.

Returns

An IntervalDictionary`2

Parameters
Name Type Description
enumerable System.Collections.Generic.IEnumerable{System.ValueTuple{Semantica.Intervals.IInterval{``0},``1}} An enumerable of tuples of intervals and values.
Generic Types
Name Description
TKey Type of the bounds of the intervals.
TValue Type of the values associated with each interval.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-ToIntervalDictionary3-System-Collections-Generic-IEnumerable{System-ValueTuple{1,``2}}-'></a>

ToIntervalDictionary``3(enumerable) method

Summary

Creates a new IntervalDictionary`3 containing the intervals and values from the provided IEnumerable`1 of tuples.

Returns

An IntervalDictionary`3

Parameters
Name Type Description
enumerable System.Collections.Generic.IEnumerable{System.ValueTuple{``1,``2}} An enumerable of tuples of intervals and values.
Generic Types
Name Description
TKey Type of the bounds of the intervals.
TValue Type of the values associated with each interval.
TInterval Type of the intervals.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-ToLowerboundIntervalPairs2-System-Collections-Generic-IEnumerable{0},System-Func{0,1},``1-'></a>

ToLowerboundIntervalPairs``2(values,leftFunc,finalRight) method

Summary

Enumerates values, and yields a KeyValuePair`2 where each key is an interval that has left (lower) bound derived from each element, and right (upper) bound derived from the subsequent element in the enumeration using leftFunc. The values of the pair are the elements of the input. The right bound of the last pair is set to finalRight;

Returns

An IEnumerable`1 of pairs with intervals and values.

Parameters
Name Type Description
values System.Collections.Generic.IEnumerable{``0} Enumeration of values.
leftFunc System.Func{``0,``1} Function used to obtain a bound value from each value.
finalRight ``1 Right bound of the interval associated with the last value in the enumeration.
Generic Types
Name Description
TValue Type of the values.
TKey Type of the bounds of the intervals.
Remarks

Note that two elements of the input IEnumerable`1 are taken before the first element is yielded. After that one element is taken for each element yielded.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-ToLowerboundIntervalTuples2-System-Collections-Generic-IEnumerable{0},System-Func{0,1},``1-'></a>

ToLowerboundIntervalTuples``2(values,leftFunc,finalRight) method

Summary

Enumerates values, and yields a tuple of an interval and a value where each key is an interval that has left (lower) bound derived from each element, and right (upper) bound derived from the subsequent element in the enumeration using leftFunc. The values of the tuples are the elements of the input. The right bound of the last pair is set to finalRight;

Returns

An IEnumerable`1 of tuples with intervals and values.

Parameters
Name Type Description
values System.Collections.Generic.IEnumerable{``0} Enumeration of values.
leftFunc System.Func{``0,``1} Function used to obtain a bound value from each value.
finalRight ``1 Right bound of the interval associated with the last value in the enumeration.
Generic Types
Name Description
TValue Type of the values.
TKey Type of the bounds of the intervals.
Remarks

Note that two elements of the input IEnumerable`1 are taken before the first element is yielded. After that one element is taken for each element yielded.

<a name='M-Semantica-Intervals-IntervalEnumerationExtensions-ToLowerboundIntervalTuples3-System-Collections-Generic-IEnumerable{0},System-Func{1,1,2},System-Func{0,1},1-'></a>

ToLowerboundIntervalTuples``3(values,intervalFactory,leftFunc,finalRight) method

Summary

Enumerates values, and yields a tuple of an interval and a value where each key is an interval that has left (lower) bound derived from each element, and right (upper) bound derived from the subsequent element in the enumeration using leftFunc. The values of the tuples are the elements of the input. The right bound of the last pair is set to finalRight;

Returns

An IEnumerable`1 of tuples with intervals and values.

Parameters
Name Type Description
values System.Collections.Generic.IEnumerable{``0} Enumeration of values.
intervalFactory System.Func{``1,``1,``2} Function to create the intervals.
leftFunc System.Func{``0,``1} Function used to obtain a bound value from each value.
finalRight ``1 Right bound of the interval associated with the last value in the enumeration.
Generic Types
Name Description
TValue Type of the values.
TKey Type of the bounds of the intervals.
TInterval Type of the created intervals.
Remarks

Note that two elements of the input IEnumerable`1 are taken before the first element is yielded. After that one element is taken for each element yielded.

<a name='T-Semantica-Intervals-IntervalExtensions'></a>

IntervalExtensions type

Namespace

Semantica.Intervals

Summary

Provides extension methods for IReadOnlyInterval`1.

<a name='M-Semantica-Intervals-IntervalExtensions-Convert2-Semantica-Intervals-IReadOnlyInterval{0},System-Func{0,1}-'></a>

Convert``2(interval,convertFunc) method

Summary

Creates an Interval`1 with the bounds of interval converted using provided converter.

Returns

New instance of Interval`1 derived from interval.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} IReadOnlyInterval`1 to convert.
convertFunc System.Func{``0,``1} Function to convert the bounds with.
Generic Types
Name Description
TIn Type of bounds of the input interval.
TOut Type of bounds of the returned interval.

<a name='M-Semantica-Intervals-IntervalExtensions-Extend1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

Extend``1(interval,otherInterval) method

Summary

Creates an Interval`1 with the left (lower) bound taken from the minimal value in either of the inputs intervals, and the right (upper) bound taken from the maximal value in either of the inputs.

Returns

New instance of Interval`1 spanning all the values within either input interval, and all values in between.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} First IReadOnlyInterval`1 to use.
otherInterval Semantica.Intervals.IReadOnlyInterval{``0} Second IReadOnlyInterval`1 to use.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalExtensions-IsAnyLeftOf1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsAnyLeftOf``1(interval,otherInterval) method

Summary

Determines if any values in interval are left of otherInterval.

Returns

true if interval has any values left of otherInterval. Always false if either of the intervals are empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} First IReadOnlyInterval`1 to compare to.
otherInterval Semantica.Intervals.IReadOnlyInterval{``0} Second IReadOnlyInterval`1 to compare fo first.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalExtensions-IsAnyLeftOf1-Semantica-Intervals-IReadOnlyInterval{0},``0-'></a>

IsAnyLeftOf``1(interval,value) method

Summary

Determines if any values in interval are left of value.

Returns

true if interval has any values left of value. Always false if the interval is empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} IReadOnlyInterval`1 to compare to.
value ``0 A single value of type T.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalExtensions-IsAnyRightOf1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsAnyRightOf``1(interval,otherInterval) method

Summary

Determines if any values in interval are right of otherInterval.

Returns

true if interval has any values right of otherInterval. Always false if either of the intervals are empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} First IReadOnlyInterval`1 to compare to.
otherInterval Semantica.Intervals.IReadOnlyInterval{``0} Second IReadOnlyInterval`1 to compare fo first.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalExtensions-IsAnyRightOf1-Semantica-Intervals-IReadOnlyInterval{0},``0-'></a>

IsAnyRightOf``1(interval,value) method

Summary

Determines if any values in interval are right of value.

Returns

true if interval has any values right of value. Always false if the interval is empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} IReadOnlyInterval`1 to compare to.
value ``0 A single value of type T.

<a name='M-Semantica-Intervals-IntervalExtensions-IsLeftOf1-0,Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsLeftOf``1(value,interval) method

Summary

Determines if value is left of interval.

Returns

true if value is left of interval. Always false if either of the intervals are empty.

Parameters
Name Type Description
value ``0 A single value of type T to compare to.
interval Semantica.Intervals.IReadOnlyInterval{``0} The IReadOnlyInterval`1 to compare to the value.

<a name='M-Semantica-Intervals-IntervalExtensions-IsLeftOf1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsLeftOf``1(interval,otherInterval) method

Summary

Determines if all values in interval are left of otherInterval.

Returns

true if interval is completely left of otherInterval. Always false if either of the intervals are empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} First IReadOnlyInterval`1 to compare.
otherInterval Semantica.Intervals.IReadOnlyInterval{``0} Second IReadOnlyInterval`1 to compare fo first.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalExtensions-IsRightOf1-0,Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsRightOf``1(value,interval) method

Summary

Determines if value is right of interval.

Returns

true if value is right of interval. Always false if either of the intervals are empty.

Parameters
Name Type Description
value ``0 A single value of type T to compare to.
interval Semantica.Intervals.IReadOnlyInterval{``0} The IReadOnlyInterval`1 to compare to the value.

<a name='M-Semantica-Intervals-IntervalExtensions-IsRightOf1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsRightOf``1(interval,otherInterval) method

Summary

Determines if all values in interval are right of otherInterval.

Returns

true if interval is completely right of otherInterval. Always false if either of the intervals are empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} First IReadOnlyInterval`1 to compare.
otherInterval Semantica.Intervals.IReadOnlyInterval{``0} Second IReadOnlyInterval`1 to compare fo first.

<a name='M-Semantica-Intervals-IntervalExtensions-IsWithin1-0,Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsWithin``1(value,interval) method

Summary

Determines if value is within interval.

Returns

true if the value is within interval. Always false if the interval is empty.

Parameters
Name Type Description
value ``0 A single value of type T to compare to.
interval Semantica.Intervals.IReadOnlyInterval{``0} The IReadOnlyInterval`1 to compare to the value.

<a name='M-Semantica-Intervals-IntervalExtensions-IsWithin1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

IsWithin``1(interval,otherInterval) method

Summary

Determines if all values in interval are in otherInterval.

Returns

true if the complete interval is within otherInterval. Always false if one of the intervals is empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} First IReadOnlyInterval`1 to compare.
otherInterval Semantica.Intervals.IReadOnlyInterval{``0} Second IReadOnlyInterval`1 to compare fo first.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalExtensions-Overlaps1-Semantica-Intervals-IReadOnlyInterval{0},Semantica-Intervals-IReadOnlyInterval{``0}-'></a>

Overlaps``1(interval,otherInterval) method

Summary

Determines if any values in interval are in otherInterval.

Returns

true if the intervals overlap. Always false if one of the intervals is empty.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} First IReadOnlyInterval`1 to compare.
otherInterval Semantica.Intervals.IReadOnlyInterval{``0} Second IReadOnlyInterval`1 to compare fo first.
Generic Types
Name Description
T Type of bounds of the intervals.

<a name='M-Semantica-Intervals-IntervalExtensions-TryDegenerateValue1-Semantica-Intervals-IReadOnlyInterval{0},``0@-'></a>

TryDegenerateValue``1(interval,degenerateValue) method

Summary

Checks interval for degeneracy. Returns the interval's value as out parameter.

Returns

true if the intervals is degenerate; false otherwise.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{``0} IReadOnlyInterval`1 to check.
degenerateValue ``0@ Out parameter containing the value of the interval.
Generic Types
Name Description
T Type of bounds of the interval.

<a name='T-Semantica-Intervals-IntervalKindExtensions'></a>

IntervalKindExtensions type

Namespace

Semantica.Intervals

Summary

Provides extension methods for IntervalBoundKind, IntervalOpenKind, as well as extension methods for IReadOnlyInterval`1 using those properties.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsHalfOpen-Semantica-Intervals-IntervalOpenKind-'></a>

IsHalfOpen() method

Summary

true if left closed, and right open.

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsHalfOpen1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsHalfOpen``1() method

Summary

true if the left boundary is closed, and the right boundary is open.

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftBounded-Semantica-Intervals-IntervalBoundKind-'></a>

IsLeftBounded() method

Summary

true if left bounded (not infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftBounded1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsLeftBounded``1() method

Summary

true if the left (lower) boundary is considered to be bound (not infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftClosed-Semantica-Intervals-IntervalOpenKind-'></a>

IsLeftClosed() method

Summary

true if left closed (bound included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftClosed1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsLeftClosed``1() method

Summary

true if the left (lower) boundary is considered to be closed (included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftOpen-Semantica-Intervals-IntervalOpenKind-'></a>

IsLeftOpen() method

Summary

true if left open (bound not included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftOpen1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsLeftOpen``1() method

Summary

true if the left (lower) boundary is considered to be open (not included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftUnbound-Semantica-Intervals-IntervalBoundKind-'></a>

IsLeftUnbound() method

Summary

true if left unbounded (infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsLeftUnbound1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsLeftUnbound``1() method

Summary

true if the left (lower) boundary is considered to be unbound (infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightBounded-Semantica-Intervals-IntervalBoundKind-'></a>

IsRightBounded() method

Summary

true if right bounded (not infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightBounded1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsRightBounded``1() method

Summary

true if the right (upper) boundary is considered to be bound (not infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightClosed-Semantica-Intervals-IntervalOpenKind-'></a>

IsRightClosed() method

Summary

true if right closed (bound included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightClosed1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsRightClosed``1() method

Summary

true if the right (upper) boundary is considered to be closed (included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightOpen-Semantica-Intervals-IntervalOpenKind-'></a>

IsRightOpen() method

Summary

true if right open (bound not included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightOpen1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsRightOpen``1() method

Summary

true if the right (upper) boundary is considered to be open (not included within the interval).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightUnbound-Semantica-Intervals-IntervalBoundKind-'></a>

IsRightUnbound() method

Summary

true if right unbounded (infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsRightUnbound1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsRightUnbound``1() method

Summary

true if the right (upper) boundary is considered to be unbound (infinite).

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsUnbound-Semantica-Intervals-IntervalBoundKind-'></a>

IsUnbound() method

Summary

true if unbounded (infinite) on both sides.

Parameters

This method has no parameters.

<a name='M-Semantica-Intervals-IntervalKindExtensions-IsUnbound1-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

IsUnbound``1() method

Summary

true if the interval is unbounded (infinite) on both sides.

Parameters

This method has no parameters.

<a name='T-Semantica-Intervals-IntervalOpenKind'></a>

IntervalOpenKind type

Namespace

Semantica.Intervals

Summary

A flags enum that can indicating whether either the left or right bounds of an interval are closed or open. A closed bound means that the bound's value itself is included in the interval, open means that the bound is not included in the interval. default indicates both bounds are closed.

<a name='T-Semantica-Intervals-Interval`1'></a>

Interval`1 type

Namespace

Semantica.Intervals

Summary

Represents an interval of values.

Generic Types
Name Description
T Any IComparable`1 type.

<a name='M-Semantica-Intervals-Interval1-#ctor-0,`0,Semantica-Intervals-IntervalOpenKind,Semantica-Intervals-IntervalBoundKind-'></a>

#ctor(left,right,openKind,boundKind) constructor

Summary

Constructs an Interval. Degenerate and Empty flags will be determined using the bounds and kinds.

Parameters
Name Type Description
left `0 Left (lower) boundary of the interval.
right `0 Right (upper) boundary of the interval.
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind indicating if any bounds are open. Default is half-open.
boundKind Semantica.Intervals.IntervalBoundKind IntervalBoundKind indicating if sides are bound or unbound.
Exceptions
Name Description
System.ArgumentException throws if left is greater than right.
Remarks

If a side is unbound, that side's open flag will be ignored and it will always be open.

<a name='M-Semantica-Intervals-Interval1-#ctor-Semantica-Intervals-IReadOnlyInterval{0}-'></a>

#ctor(interval) constructor

Summary

Constructs an Interval`1 that is a functional copy of another interval.

Parameters
Name Type Description
interval Semantica.Intervals.IReadOnlyInterval{`0} Any interval implementing IReadOnlyInterval`1.

<a name='M-Semantica-Intervals-Interval1-#ctor-0,`0,Semantica-Intervals-IntervalOpenKind,Semantica-Intervals-IntervalBoundKind,System-Boolean,System-Boolean-'></a>

#ctor() constructor

Summary

constructor used in the static Interval methods;

Parameters

This constructor has no parameters.

<a name='F-Semantica-Intervals-Interval`1-_flags'></a>

_flags constants

<a name='T-Semantica-Intervals-TargetInterval`1'></a>

TargetInterval`1 type

Namespace

Semantica.Intervals

Summary

An implementation of IInterval`1 that is defined by a center point (TargetValue) and a distance of the bounds to that center point (Margin). This means these intervals are always bounded on both sides.

Generic Types
Name Description
T Any type implementing IArithmatic`1 and IComparable`1.
Remarks

Is considered empty when Margin is default, which is slightly different from other typesof intervals. Consequently, these intervals are never considered degenerate.

<a name='M-Semantica-Intervals-TargetInterval1-#ctor-0,`0,Semantica-Intervals-IntervalOpenKind-'></a>

#ctor(targetValue,margin,openKind) constructor

Summary

Constructs the interval centered around targetValue, with either bounds margin away from either side of that value.

Parameters
Name Type Description
targetValue `0 The center of the interval.
margin `0 The margin of the interval (distance of either bound to the interval).
openKind Semantica.Intervals.IntervalOpenKind IntervalOpenKind value indicating whether the bounds are open or closed.

<a name='P-Semantica-Intervals-TargetInterval`1-Margin'></a>

Margin property

Summary

The margin (radius) of the interval. This value is subtracted from TargetValue to obtain Left; added to get Right.

<a name='P-Semantica-Intervals-TargetInterval`1-TargetValue'></a>

TargetValue property

Summary

The value representing the center of the interval, from which the bounds are calculated.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Semantica.Lib.Intervals:

Package Downloads
Semantica.Lib.Package.Core

Combines all primary Semantica.Lib.Core packages in a single package. Check the ReadMe of each package for further elaboration on package contents.
Semantica.Lib.TestTools.Core

Provides a set of specific MSTest.Assert extensions (Assert.That.), to facilitate more compact assertions, and more comprehensive fail messages. Assertions include epsilon-checking for floating point types, default/empty checking for enums, strings, ICanBeEmpty, etc., DateOnly/DateTime part assertions, as well as assertions for the Semantica.Lib.Checks.Chk type. Also contains a convenient mock for Semantica.Lib.Core.Providers.IDateTimeProvider, and ModuleTestBase, an abstract base class to facilitate making unit tests for DI modules based on Semantica.Lib.Core.DependencyInjection.ModuleBase.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
8.1.0-beta 120 5/30/2025
8.0.7-beta 145 9/6/2024
8.0.6-beta 733 7/10/2024
8.0.5-beta 182 7/4/2024
8.0.4-beta 128 7/2/2024
8.0.3-beta 127 6/14/2024
8.0.2-beta 196 6/4/2024
8.0.1-beta 126 6/4/2024
8.0.0-beta 141 6/4/2024
6.6.1-beta 259 4/5/2024
6.6.0-beta 298 3/5/2024
6.5.5-alpha2 98 3/4/2024
6.5.5-alpha 81 3/4/2024
6.5.4-beta 132 2/29/2024
6.5.3-beta 528 10/5/2023
6.5.2-beta 123 10/5/2023
6.5.1-beta 180 9/29/2023
6.5.0-beta 127 9/22/2023
6.4.0-beta 439 7/11/2023
6.3.0-beta 156 6/15/2023
6.2.5-beta 235 3/14/2023
6.2.4-beta 618 10/12/2022
6.2.3-beta 299 9/1/2022
6.2.1-beta 212 8/25/2022