Packages

  • package o1
    Definition Classes
    root
  • package grid

    This package contains tools for working with grid-like two-dimensional structures.

    This package contains tools for working with grid-like two-dimensional structures.

    The contents of this package have aliases in the top-level package o1, so they are accessible to students simply via import o1._.

    Definition Classes
    o1
  • CompassDir
  • Grid
  • GridPos
c

o1.grid

GridPos

case class GridPos(x: Int, y: Int) extends Product with Serializable

An object of type GridPos represents a pair of integer coordinates on two axes named x and y. Such a pair can be used to reference a point on a Grid.

In this coordinate system, x increases "eastwards" and y increases "southwards".

GridPos objecta are immutable.

This class has an alias in the top-level package o1, so it’s accessible to students simply via import o1._.

x

an x coordinate

y

a y coordinate

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GridPos
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GridPos(x: Int, y: Int)

    x

    an x coordinate

    y

    a y coordinate

Value Members

  1. def ==(another: GridPos): Boolean

    Determines whether this grid position equals the given one.

    Determines whether this grid position equals the given one. This is the case if the two have identical x and y coordinates.

  2. def diff(another: GridPos): (Int, Int)

    Returns the xDiff and yDiff between this GridPos and the given one as a pair.

  3. def distance(another: GridPos): Int

    Returns the "grid distance" between this GridPos and the given one.

    Returns the "grid distance" between this GridPos and the given one. The grid distance between a and b equals a.xDiff(b).abs + a.yDiff(b).abs.

  4. def neighbor(direction: CompassDir): GridPos

    Returns a grid position that "neighbors" this one in the given direction.

    Returns a grid position that "neighbors" this one in the given direction. For instance, if this position has an x of 10 and a y of 20, and the direction parameter is given the value CompassDir.South, then the result has an x of 10 and a y of 21. Calling this method is essentially the same as calling relative with a distance of one.

  5. def pathTowards(direction: CompassDir): LazyList[GridPos]

    Returns an infinite lazy-list of locations at increasing distances from this GridPos in the given direction.

    Returns an infinite lazy-list of locations at increasing distances from this GridPos in the given direction. For example, if this GridPos is (10,1), and the direction is South, returns a list of (10,2), (10,3), (10,4), etc.

  6. def productElementNames: Iterator[String]
    Definition Classes
    Product
  7. def relative(direction: CompassDir, distance: Int): GridPos

    Returns another grid position that is in the given direction from this one and at a given distance.

    Returns another grid position that is in the given direction from this one and at a given distance.

    For instance, say this position has an x of 10 and a y of 20. If direction is CompassDir.North and distance is 3, then the result has an x of 10 and a y of 17.

    See also

    CompassDir.xStep, CompassDir.yStep

  8. def toString: String

    Returns a textual description of this position.

    Returns a textual description of this position. The description is of the form "(x,y)".

    Definition Classes
    GridPos → AnyRef → Any
  9. val x: Int
  10. def xDiff(another: GridPos): Int

    Returns the difference between the x coordinate of this GridPos and that of the given GridPos.

    Returns the difference between the x coordinate of this GridPos and that of the given GridPos. The result is negative if the x coordinate of this GridPos is greater.

  11. def xDirectionOf(another: GridPos): Option[CompassDir]

    Determines if the given GridPos is west or east of this one.

    Determines if the given GridPos is west or east of this one. Returns East if this GridPos’s x coordinate is less than another’s and West if the opposite is true. Wraps that return value in an Option; None means that the x coordinates are equal.

  12. val y: Int
  13. def yDiff(another: GridPos): Int

    Returns the difference between the y coordinate of this GridPos and that of the given GridPos.

    Returns the difference between the y coordinate of this GridPos and that of the given GridPos. The result is negative if the y coordinate of this GridPos is greater.

  14. def yDirectionOf(another: GridPos): Option[CompassDir]

    Determines if the given GridPos is north or south of this one.

    Determines if the given GridPos is north or south of this one. Returns South if this GridPos’s y coordinate is less than another’s and North if the opposite is true. Wraps that direction in an Option; None means that the y coordinates are equal.