maths.special_numbers.hexagonal_number
======================================

.. py:module:: maths.special_numbers.hexagonal_number

.. autoapi-nested-parse::

   == Hexagonal Number ==
   The nth hexagonal number hn is the number of distinct dots
   in a pattern of dots consisting of the outlines of regular
   hexagons with sides up to n dots, when the hexagons are
   overlaid so that they share one vertex.

   https://en.wikipedia.org/wiki/Hexagonal_number



Functions
---------

.. autoapisummary::

   maths.special_numbers.hexagonal_number.hexagonal


Module Contents
---------------

.. py:function:: hexagonal(number: int) -> int

   :param number: nth hexagonal number to calculate
   :return: the nth hexagonal number
   Note: A hexagonal number is only defined for positive integers
   >>> hexagonal(4)
   28
   >>> hexagonal(11)
   231
   >>> hexagonal(22)
   946
   >>> hexagonal(0)
   Traceback (most recent call last):
       ...
   ValueError: Input must be a positive integer
   >>> hexagonal(-1)
   Traceback (most recent call last):
       ...
   ValueError: Input must be a positive integer
   >>> hexagonal(11.0)
   Traceback (most recent call last):
       ...
   TypeError: Input value of [number=11.0] must be an integer