Skip to content

Commit

Permalink
fix inequality docs
Browse files Browse the repository at this point in the history
  • Loading branch information
natashawatkins committed Dec 11, 2018
1 parent 97f68f5 commit df33bfb
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions quantecon/inequality.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ def gini_coefficient(y):
References
----------
.. [1] https://en.wikipedia.org/wiki/Gini_coefficient
https://en.wikipedia.org/wiki/Gini_coefficient
"""
n = len(y)
i_sum = np.zeros(n)
Expand All @@ -96,21 +96,20 @@ def shorrocks_index(A):
Returns
--------
Shorrocks index : float
The Shorrocks mobility index calculated as:
Shorrocks index: float
The Shorrocks mobility index calculated as
.. math::
s(A) = \frac{m - \sum_j a_{jj}}{m - 1} \in (0, 1)
s(A) = \frac{m - \sum_j a_{jj} }{m - 1} \in (0, 1)
An index equal to 0 indicates complete immobility.
References
----------
.. [1] Benhabib, Bison, and Luo, Wealth distribution and social mobility
in the US: A quantitative approach (2017), https://www.econ.nyu.edu/user/bisina/RevisionAugust.pdf
-----------
.. [1] Wealth distribution and social mobility in the US: A quantitative approach
(Benhabib, Bisin, Luo, 2017).
https://www.econ.nyu.edu/user/bisina/RevisionAugust.pdf
"""

A = np.asarray(A) # Convert to array if not already
Expand Down

0 comments on commit df33bfb

Please sign in to comment.