Files
cours-420-301-ah/docs/index.html
T

1272 lines
23 KiB
HTML

<!doctype html>
<html lang="en">
<head>
<meta charset='utf-8'>
<title> | Documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'>
<link href='assets/style.css' rel='stylesheet'>
<link href='assets/github.css' rel='stylesheet'>
<link href='assets/split.css' rel='stylesheet'>
</head>
<body class='documentation m0'>
<div class='flex'>
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'></h3>
<div class='mb1'><code></code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
spellcheck='false'
autocapitalize='off'
autocorrect='off'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#hockeygame'
class=" toggle-sibling">
HockeyGame
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#hockeygamehome'
class='regular pre-open'>
#home
</a></li>
<li><a
href='#hockeygameaway'
class='regular pre-open'>
#away
</a></li>
<li><a
href='#hockeygamehometeamscores'
class='regular pre-open'>
#homeTeamScores
</a></li>
<li><a
href='#hockeygameawayteamscores'
class='regular pre-open'>
#awayTeamScores
</a></li>
<li><a
href='#hockeygamewinner'
class='regular pre-open'>
#winner
</a></li>
</ul>
</div>
</li>
<li><a
href='#hockeyplayer'
class=" toggle-sibling">
HockeyPlayer
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#hockeyplayerfirstname'
class='regular pre-open'>
#firstName
</a></li>
<li><a
href='#hockeyplayerlastname'
class='regular pre-open'>
#lastName
</a></li>
<li><a
href='#hockeyplayerdateofbirth'
class='regular pre-open'>
#dateOfBirth
</a></li>
<li><a
href='#hockeyplayername'
class='regular pre-open'>
#name
</a></li>
<li><a
href='#hockeyplayercurrentage'
class='regular pre-open'>
#currentAge
</a></li>
</ul>
</div>
</li>
<li><a
href='#isvalidisbn13'
class="">
isValidIsbn13
</a>
</li>
<li><a
href='#isvalidisbn10'
class="">
isValidIsbn10
</a>
</li>
<li><a
href='#isvalidisbn'
class="">
isValidIsbn
</a>
</li>
<li><a
href='#infinity'
class="">
INFINITY
</a>
</li>
<li><a
href='#average'
class="">
average
</a>
</li>
<li><a
href='#std'
class="">
std
</a>
</li>
</ul>
</div>
<div class='mt1 h6 quiet'>
<a href='https://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
</div>
</div>
</div>
<div id='split-right' class='relative overflow-auto height-viewport-100'>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='hockeygame'>
HockeyGame
</h3>
</div>
<p>Represent a the scoring of a hockey game. The two teams
playing are "home" and "away".</p>
<div class='pre p1 fill-light mt0'>new HockeyGame()</div>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='border-bottom' id='hockeygamehome'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>home</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Score of the "home" team</p>
<div class='pre p1 fill-light mt0'>home</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeygameaway'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>away</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Score of the "away" team</p>
<div class='pre p1 fill-light mt0'>away</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeygamehometeamscores'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>homeTeamScores()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Call this method when home team scores. It will
increase home team score by 1 point.</p>
<div class='pre p1 fill-light mt0'>homeTeamScores()</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeygameawayteamscores'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>awayTeamScores()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Call this method when away team scores. It will
increase home team score by 1 point.</p>
<div class='pre p1 fill-light mt0'>awayTeamScores()</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeygamewinner'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>winner()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Returns winner of the game.</p>
<div class='pre p1 fill-light mt0'>winner(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
the name of the winner team. Either "home", "away" or "tie"
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='hockeyplayer'>
HockeyPlayer
</h3>
</div>
<p>Class representing a simple hockey player. The hockey player
has a name (first and last) and a date of birth.</p>
<div class='pre p1 fill-light mt0'>new HockeyPlayer(firstName: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, lastName: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, dateOfBirth: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>firstName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
the first name of the player
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>lastName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
the last name of the player
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>dateOfBirth</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>)</code>
the birth date of the player
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='border-bottom' id='hockeyplayerfirstname'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>firstName</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the fist name of the player.</p>
<div class='pre p1 fill-light mt0'>firstName</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerlastname'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>lastName</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the last name of the player.</p>
<div class='pre p1 fill-light mt0'>lastName</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerdateofbirth'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>dateOfBirth</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the date of birth of the player.</p>
<div class='pre p1 fill-light mt0'>dateOfBirth</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayername'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>name</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the full name of the player.</p>
<div class='pre p1 fill-light mt0'>name</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayercurrentage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>currentAge()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Returns the current age of the player in years.</p>
<div class='pre p1 fill-light mt0'>currentAge()</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='isvalidisbn13'>
isValidIsbn13
</h3>
</div>
<p>Validate is the input string is a valid 13 digits ISBN as defined
in <a href="https://en.wikipedia.org/wiki/ISBN">https://en.wikipedia.org/wiki/ISBN</a></p>
<div class='pre p1 fill-light mt0'>isValidIsbn13(str: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>str</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
a text we want to test if it is a real isbn
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>:
true/false depending is str is a valid 13 digits ISBN
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='isvalidisbn10'>
isValidIsbn10
</h3>
</div>
<p>Validate is the input string is a valid 10 digits ISBN as defined
in <a href="https://en.wikipedia.org/wiki/ISBN">https://en.wikipedia.org/wiki/ISBN</a></p>
<div class='pre p1 fill-light mt0'>isValidIsbn10(str: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>str</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
a text we want to test if it is a real isbn
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>:
true/false depending is str is a valid 10 digits ISBN
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='isvalidisbn'>
isValidIsbn
</h3>
</div>
<p>Validate is the input string is a valid ISBN <a href="https://en.wikipedia.org/wiki/ISBN">https://en.wikipedia.org/wiki/ISBN</a></p>
<div class='pre p1 fill-light mt0'>isValidIsbn(str: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>str</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
a text we want to test if it is a real isbn
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>:
true/false depending is str is a valid isbn
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='infinity'>
INFINITY
</h3>
</div>
<p>In statistics, infinity is set to 30.</p>
<div class='pre p1 fill-light mt0'>INFINITY</div>
<p>
Type:
<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>
</p>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='average'>
average
</h3>
</div>
<p>Computes the average of the list. If the list is empty, the
function returns NaN</p>
<div class='pre p1 fill-light mt0'>average(lst: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>): any</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>lst</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>)</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code>any</code>:
the average of the list.
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='std'>
std
</h3>
</div>
<p>Computes the standard deviation of the list. If the list is empty, the
function returns NaN</p>
<div class='pre p1 fill-light mt0'>std(lst: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>): any</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>lst</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>)</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code>any</code>:
the standard deviation of the list.
</section>
</div>
</div>
<script src='assets/anchor.js'></script>
<script src='assets/split.js'></script>
<script src='assets/site.js'></script>
</body>
</html>