djib/Sushi
1
0
Fork 0
Code Issues 2 Pull Requests Releases 1 Activity
Files
4ff5478d8c5cb46d7653c4fb20a02fd933d9f58e
Sushi/doc/suicideChess/Board.html

501 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_05) on Tue Jan 17 15:42:44 GMT 2006 -->
<TITLE>
Board
</TITLE>
<META NAME="keywords" CONTENT="suicideChess.Board class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Board";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../suicideChess/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Board.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?suicideChess/Board.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Board.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
suicideChess</FONT>
<BR>
Class Board</H2>
<PRE>
java.lang.Object
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>suicideChess.Board</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Board</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class contains the board representation.
The board is represented using bitboards.
<ul><li>a1 is square 0</li>
<li>h8 is square 7</li>
<li>a2 is square 8</li>
<li>... and so on</li>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$LastChangedRevision$, $LastChangedDate$</DD>
<DT><B>Author:</B></DT>
<DD>Jean-Baptiste H&eacute;tier</DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess">Board.NoPieceOnSquare</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#NB_OF_FILES">NB_OF_FILES</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#NB_OF_RANKS">NB_OF_RANKS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#NB_OF_SQUARES">NB_OF_SQUARES</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../suicideChess/Board.html#Board()">Board</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor of the class Board</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#display()">display</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This function can be used to display the board
Black pieces are displayed in uppercase letters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#doMove(suicideChess.Move)">doMove</A></B>(<A HREF="../suicideChess/Move.html" title="class in suicideChess">Move</A>&nbsp;move)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This methods takes a <A HREF="../suicideChess/Move.html" title="class in suicideChess"><CODE>Move</CODE></A> and applies it (updating the bitboard)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#getEnPassantSquare()">getEnPassantSquare</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This function is used to return the 'en passant' Square.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../suicideChess/Piece.html" title="class in suicideChess">Piece</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#getPiece(suicideChess.Square)">getPiece</A></B>(<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>&nbsp;onSquare)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This function searchs for what piece is on a square.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#isEmpty(suicideChess.Square, suicideChess.Piece)">isEmpty</A></B>(<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>&nbsp;square,
<A HREF="../suicideChess/Piece.html" title="class in suicideChess">Piece</A>&nbsp;piece)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This function returns a boolean telling if a <A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A> is on a <A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#isEnPassant()">isEnPassant</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This function returns a boolean saying if the board is in an 'en passant' state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#squareToBitBoardSquare(suicideChess.Square)">squareToBitBoardSquare</A></B>(<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>&nbsp;square)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This function converts a <A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A> to a number representing a bitboard square</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="NB_OF_RANKS"><!-- --></A><H3>
NB_OF_RANKS</H3>
<PRE>
public static final int <B>NB_OF_RANKS</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#suicideChess.Board.NB_OF_RANKS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NB_OF_FILES"><!-- --></A><H3>
NB_OF_FILES</H3>
<PRE>
public static final int <B>NB_OF_FILES</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#suicideChess.Board.NB_OF_FILES">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NB_OF_SQUARES"><!-- --></A><H3>
NB_OF_SQUARES</H3>
<PRE>
public static final int <B>NB_OF_SQUARES</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#suicideChess.Board.NB_OF_SQUARES">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Board()"><!-- --></A><H3>
Board</H3>
<PRE>
public <B>Board</B>()
throws <A HREF="../suicideChess/Square.NotAValidSquare.html" title="class in suicideChess">Square.NotAValidSquare</A></PRE>
<DL>
<DD>Constructor of the class Board
<P>
<DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../suicideChess/Square.NotAValidSquare.html" title="class in suicideChess">Square.NotAValidSquare</A></CODE></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="doMove(suicideChess.Move)"><!-- --></A><H3>
doMove</H3>
<PRE>
public void <B>doMove</B>(<A HREF="../suicideChess/Move.html" title="class in suicideChess">Move</A>&nbsp;move)
throws <A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess">Board.NoPieceOnSquare</A></PRE>
<DL>
<DD>This methods takes a <A HREF="../suicideChess/Move.html" title="class in suicideChess"><CODE>Move</CODE></A> and applies it (updating the bitboard)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>move</CODE> - The move that is to be done
<DT><B>Throws:</B>
<DD><CODE><A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess">Board.NoPieceOnSquare</A></CODE> - If a piece is trying to be moved from a square that does not exist.<DT><B>See Also:</B><DD><A HREF="../suicideChess/Move.html" title="class in suicideChess"><CODE>Move</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getPiece(suicideChess.Square)"><!-- --></A><H3>
getPiece</H3>
<PRE>
public <A HREF="../suicideChess/Piece.html" title="class in suicideChess">Piece</A> <B>getPiece</B>(<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>&nbsp;onSquare)</PRE>
<DL>
<DD>This function searchs for what piece is on a square.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>onSquare</CODE> - The Square on which we will look for a piece.
<DT><B>Returns:</B><DD>a <A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A><DT><B>See Also:</B><DD><A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A>,
<A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isEmpty(suicideChess.Square, suicideChess.Piece)"><!-- --></A><H3>
isEmpty</H3>
<PRE>
public boolean <B>isEmpty</B>(<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>&nbsp;square,
<A HREF="../suicideChess/Piece.html" title="class in suicideChess">Piece</A>&nbsp;piece)</PRE>
<DL>
<DD>This function returns a boolean telling if a <A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A> is on a <A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>square</CODE> - The Square<DD><CODE>piece</CODE> - A Piece constant
<DT><B>Returns:</B><DD>boolean<DT><B>See Also:</B><DD><A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A>,
<A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="squareToBitBoardSquare(suicideChess.Square)"><!-- --></A><H3>
squareToBitBoardSquare</H3>
<PRE>
public static int <B>squareToBitBoardSquare</B>(<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>&nbsp;square)</PRE>
<DL>
<DD>This function converts a <A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A> to a number representing a bitboard square
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>square</CODE> - The Square to be converted
<DT><B>Returns:</B><DD>int<DT><B>See Also:</B><DD><A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isEnPassant()"><!-- --></A><H3>
isEnPassant</H3>
<PRE>
public boolean <B>isEnPassant</B>()</PRE>
<DL>
<DD>This function returns a boolean saying if the board is in an 'en passant' state.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>boolean</DL>
</DD>
</DL>
<HR>
<A NAME="getEnPassantSquare()"><!-- --></A><H3>
getEnPassantSquare</H3>
<PRE>
public <A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A> <B>getEnPassantSquare</B>()</PRE>
<DL>
<DD>This function is used to return the 'en passant' Square. Don't use it unless table is in an 'en passant' state.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Square<DT><B>See Also:</B><DD><A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="display()"><!-- --></A><H3>
display</H3>
<PRE>
public void <B>display</B>()</PRE>
<DL>
<DD>This function can be used to display the board
Black pieces are displayed in uppercase letters.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../suicideChess/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Board.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?suicideChess/Board.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Board.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink