djib/Sushi
1
0
Fork 0
Code Issues 2 Pull Requests Releases 1 Activity

Documentation generated. Some errors corrected in the code.

Browse Source
This commit is contained in:
Jean-Baptiste Hétier
2006-01-13 17:03:06 +00:00
parent 5a8d3829be
commit 9167829467
34 changed files with 1307 additions and 478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
doc/suicideChess/Board.html
View File

@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2-02) on Tue Jan 10 15:14:10 GMT 2006 -->
<!-- Generated by javadoc (build 1.5.0_05) on Fri Jan 13 17:00:36 GMT 2006 -->
<TITLE>
Board
</TITLE>
@ -17,6 +17,8 @@ function windowTitle()
parent.document.title="Board";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
@ -28,11 +30,11 @@ function windowTitle()
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<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="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<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>
@ -52,7 +54,7 @@ function windowTitle()
&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" target="_top"><B>FRAMES</B></A> &nbsp;
<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">
<!--
@ -65,6 +67,7 @@ function windowTitle()
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
@ -86,11 +89,12 @@ suicideChess</FONT>
Class Board</H2>
<PRE>
java.lang.Object
<IMG SRC="../resources/inherit.gif" ALT="extended by"><B>suicideChess.Board</B>
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>suicideChess.Board</B>
</PRE>
<HR>
<DL>
<DT>public class <B>Board</B><DT>extends java.lang.Object</DL>
<DT><PRE>public class <B>Board</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class contains the board representation.
@ -104,9 +108,9 @@ This class contains the board representation.
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$LastChangedRevision: 19 $, $LastChangedDate: 2006-01-10 12:35:32 +0000 (Tue, 10 Jan 2006) $</DD>
<DD>$LastChangedRevision: 27 $, $LastChangedDate: 2006-01-13 16:48:21 +0000 (Fri, 13 Jan 2006) $</DD>
<DT><B>Author:</B></DT>
<DD>Jean-Baptiste Hétier</DD>
<DD>Jean-Baptiste H&eacute;tier</DD>
</DL>
<HR>
@ -116,8 +120,8 @@ This class contains the board representation.
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TD>
<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">
@ -128,14 +132,13 @@ This class contains the board representation.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== FIELD SUMMARY =========== -->
&nbsp;<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
<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">
@ -168,8 +171,8 @@ This class contains the board representation.
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
<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>
@ -184,8 +187,8 @@ This class contains the board representation.
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
<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">
@ -206,17 +209,50 @@ This class contains the board representation.
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;suicideChess.Piece</CODE></FONT></TD>
<TD><CODE><B><A HREF="../suicideChess/Board.html#getPiece(suicideChess.Square)">getPiece</A></B>(suicideChess.Square&nbsp;onSquare)</CODE>
<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">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
<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>
@ -230,8 +266,8 @@ This class contains the board representation.
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
@ -269,8 +305,8 @@ public static final int <B>NB_OF_SQUARES</B></PRE>
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
@ -278,22 +314,23 @@ public static final int <B>NB_OF_SQUARES</B></PRE>
Board</H3>
<PRE>
public <B>Board</B>()
throws suicideChess.Square.NotAValidSquare</PRE>
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>NotAValidSquare</CODE>
<DD><CODE>suicideChess.Square.NotAValidSquare</CODE></DL>
<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">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
@ -316,14 +353,72 @@ public void <B>doMove</B>(<A HREF="../suicideChess/Move.html" title="class in su
<A NAME="getPiece(suicideChess.Square)"><!-- --></A><H3>
getPiece</H3>
<PRE>
public suicideChess.Piece <B>getPiece</B>(suicideChess.Square&nbsp;onSquare)</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 <CODE>Piece</CODE><DT><B>See Also:</B><DD><A HREF="../suicideChess/Board.NoPieceOnSquare.html" title="class in suicideChess"><CODE>Board.NoPieceOnSquare</CODE></A>,
<CODE>Piece</CODE></DL>
<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>
@ -349,11 +444,11 @@ public void <B>display</B>()</PRE>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<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="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<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>
@ -373,7 +468,7 @@ public void <B>display</B>()</PRE>
&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" target="_top"><B>FRAMES</B></A> &nbsp;
<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">
<!--
@ -386,6 +481,7 @@ public void <B>display</B>()</PRE>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>