dhtslib ~develop (2022-01-25T20:23:39.6291596)

Interval

dhtslib coordinates

The (start, end) coordinates within a coordinate system, where the type itself encodes the coordinate system details (zero or one-based; half-open vs. closed)

struct Interval (
CoordSystem cs
) {
alias basetype = coordinateSystemToBasis!cs;
alias endtype = coordinateSystemToEnd!cs;
@safe nothrow pure
Coordinate!basetype start;
@safe nothrow pure
Coordinate!basetype end;
this(long start, long end);
long size();
auto to();
auto to();
auto to();
auto to();
auto to();
auto offset(T off);
auto intersectImpl(Interval!cs other);
auto unionImpl(Interval!cs other);
auto isOverlap(Interval!cs other);
auto getMinStart(Interval!cs other);
auto getMaxStart(Interval!cs other);
auto getMinEnd(Interval!cs other);
auto getMaxEnd(Interval!cs other);
auto opBinary(Interval!cs other);
auto opBinary(T off);
string toString();
}

Constructors

this
this(long start, long end)

long constructor

Members

Aliases

basetype
alias basetype = coordinateSystemToBasis!cs

alias Basis and End enums for this Coordsystem type

endtype
alias endtype = coordinateSystemToEnd!cs
Undocumented in source.

Functions

getMaxEnd
auto getMaxEnd(Interval!cs other)

get maximum end value between this interval and other interval

getMaxStart
auto getMaxStart(Interval!cs other)

get maximum start value between this interval and other interval

getMinEnd
auto getMinEnd(Interval!cs other)

get minimum end value between this interval and other interval

getMinStart
auto getMinStart(Interval!cs other)

get minimum start value between this interval and other interval

intersectImpl
auto intersectImpl(Interval!cs other)

intersection of two regions

isOverlap
auto isOverlap(Interval!cs other)

does this interval overlap with the other interval?

offset
auto offset(T off)

make a new coordinate pair with a value of this.start + off and this.end + off

opBinary
auto opBinary(Interval!cs other)

Set operators for interval intersection (|) and union (&). If the intervals are non-overlapping, an empty interval is returned i.e ZBHO.init union is not a true union but returns the convex hull.

opBinary
auto opBinary(T off)

opbinary + or - to use offset

size
long size()

Return the size of the interval spanned by start and end

to
auto to()

Convert coordinates to another coordinate system

to
auto to()

Convert coordinate to another based system using shortcuts

to
auto to()

Convert coordinate to another based system using shortcuts

to
auto to()

Convert coordinate to another based system using shortcuts

to
auto to()

Convert coordinate to another based system using shortcuts

toString
string toString()

Get string representation for printing

unionImpl
auto unionImpl(Interval!cs other)

union of two regions specifically computes the convex hull of the two intervals if Intervals don't overlap returns the init Interval

Variables

end
Coordinate!basetype end;

Ending coordinate

start
Coordinate!basetype start;

Starting coordinate

Meta

Source

See Implementation

dhtslib coordinates aliasesenumsmanifest constantsstructstemplates

Page generated by adrdox