Region Class Reference

Inheritance diagram for Region:

List of all members.

Public Member Functions
	Region (int s, int e)
int	direction ()
boolean	backward ()
boolean	forward ()
String	toString ()
int	getSmallEnd ()
int	getLargeEnd ()
int	getEnd ()
int	distance (Region r)
int	compareEnd (Region r)
boolean	differentEnd (Region r)
boolean	sameEnd (Region r)
boolean	equals (Region r)
int	hashCode ()
int	compareTo (Object r)
int	directionalOverlap (Region r)
int	overlap (Region r)
Static Public Member Functions
static void	main (String[] args)
Private Attributes
int	start
int	end

---

Constructor & Destructor Documentation

Region::Region	(	int	s,
		int	e
	)			[inline]

constructor, create a region from s (start) and e (end).

References end, and start.

Referenced by main().

---

Member Function Documentation

int Region::direction

(

)

[inline]

return the directionality of the region.

Returns:

end-start as an integer.

References end, and start.

boolean Region::backward

(

)

[inline]

References end, and start.

boolean Region::forward

(

)

[inline]

References end, and start.

Referenced by ExtractEnd::extract().

String Region::toString

(

)

[inline]

References end, and start.

int Region::getSmallEnd

(

)

[inline]

return the smaller end regardless of direction.

References end, and start.

int Region::getLargeEnd

(

)

[inline]

References end, and start.

Referenced by ExtractEnd::extract().

int Region::getEnd

(

)

[inline]

References end.

Referenced by ExtractEnd::extract().

int Region::distance

(

Region

r

)

[inline]

return the distance of this Region to r. Returns a negative number if overlap.

References end, and start.

Referenced by ExtractEnd::extract().

int Region::compareEnd

(

Region

r

)

[inline]

References end.

boolean Region::differentEnd

(

Region

r

)

[inline]

References end.

Referenced by ExtractEnd::extract().

boolean Region::sameEnd

(

Region

r

)

[inline]

References end.

boolean Region::equals

(

Region

r

)

[inline]

return true if this region and r have the same start and end.

References end, and start.

int Region::hashCode

(

)

[inline]

References end, and start.

int Region::compareTo

(

Object

r

)

[inline]

References end, and start.

int Region::directionalOverlap

(

Region

r

)

[inline]

return the extent of overlap between this Region and r. In case you want to know the extent of the overlap, this method is very useful.

Returns:

if overlap returns a positive number. a negative number indicates no overlap.

References end, and start.

int Region::overlap

(

Region

r

)

[inline]

return the overlap length.

Returns:

a negative value indicates no overlap; a positive value indicates a overlap.

References end, and start.

Referenced by ExtractEnd::extract(), and main().

static void Region::main

(

String[]

args

)

[inline, static]

References overlap(), and Region().

---

Member Data Documentation

int Region::start [private]

Referenced by backward(), compareTo(), direction(), directionalOverlap(), distance(), equals(), forward(), getLargeEnd(), getSmallEnd(), hashCode(), overlap(), Region(), and toString().

int Region::end [private]

Referenced by backward(), compareEnd(), compareTo(), differentEnd(), direction(), directionalOverlap(), distance(), equals(), forward(), getEnd(), getLargeEnd(), getSmallEnd(), hashCode(), overlap(), Region(), sameEnd(), and toString().

---

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

• seqana/Region.java