Show / Hide Table of Contents

Struct Box

Defines a square region within a puzzle.

Implements
System.IEquatable<Box>
Inherited Members
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: SudokuSpice
Assembly: SudokuSpice.dll
Syntax
public struct Box : IEquatable<Box>

Constructors

| Improve this Doc View Source

Box(Coordinate, Int32)

Constructs a box covering the given region. size must be greater than 0.

Declaration
public Box(Coordinate topLeft, int size)
Parameters
Type Name Description
Coordinate topLeft
System.Int32 size

Properties

| Improve this Doc View Source

Size

The size (i.e. side-length) of this box.

Declaration
public int Size { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TopLeft

The top-left coordinate (inclusive) for this box.

Declaration
public Coordinate TopLeft { get; }
Property Value
Type Description
Coordinate

Methods

| Improve this Doc View Source

Contains(Coordinate)

Returns true if the given coordinate is part of the box.

Declaration
public bool Contains(in Coordinate coord)
Parameters
Type Name Description
Coordinate coord
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Equals(Box)

Declaration
public bool Equals(Box other)
Parameters
Type Name Description
Box other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.ValueType.Equals(System.Object)
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.ValueType.GetHashCode()

Operators

| Improve this Doc View Source

Equality(Box, Box)

Declaration
public static bool operator ==(Box left, Box right)
Parameters
Type Name Description
Box left
Box right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Inequality(Box, Box)

Declaration
public static bool operator !=(Box left, Box right)
Parameters
Type Name Description
Box left
Box right
Returns
Type Description
System.Boolean

Implements

System.IEquatable<T>
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX