-
-
Notifications
You must be signed in to change notification settings - Fork 553
isbn-verifier: Include more succinct description of ISBN-10. #1019
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
78f4742
Update description.md with more succinct description of ISBN-10.
sjwarner 6838078
isbn-verifer: add @insti 's improvements
sjwarner d12ee14
Add @coriolinus ' improvements.
sjwarner 6cecdd7
isbn-verifier: change link in description.md
sjwarner 69c65fc
isbn-verifier: update description
sjwarner 7d36578
isbn-verifier: improve grammar.
sjwarner e666992
isbn-verifier: add example ISBN-10 with 'X' as check digit
sjwarner e44ee31
isbn-verifier: move description's 'functionality' section and rename
sjwarner 4744404
isbn-verifier: change position of example
sjwarner cd2e16d
isbn-verifier: change section name and more small fixes
sjwarner 64b4e75
isbn-verifier: make formulae more consistent
sjwarner d6c506b
Add @ErikSchierboom 's improvement
sjwarner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,40 @@ | ||
Check if a given ISBN-10 is valid. | ||
The [ISBN-10 verification process](https://en.wikipedia.org/wiki/International_Standard_Book_Number) is used to validate book identification | ||
numbers. These normally contain dashes and look like: `3-598-21508-8` | ||
|
||
## Functionality | ||
## ISBN | ||
|
||
Given an unknown string the program should check if the provided string is a valid ISBN-10. | ||
Putting this into place requires some thinking about preprocessing/parsing of the string prior to calculating the check digit for the ISBN. | ||
The ISBN-10 format is 9 digits (0 to 9) plus one check character (either a digit or an X only). In the case the check character is an X, this represents the value '10'. These may be communicated with or without hyphens, and can be checked for their validity by the following formula: | ||
|
||
The program should allow for ISBN-10 without the separating dashes to be verified as well. | ||
``` | ||
(x1 * 10 + x2 * 9 + x3 * 8 + x4 * 7 + x5 * 6 + x6 * 5 + x7 * 4 + x8 * 3 + x9 * 2 + x10 * 1) mod 11 == 0 | ||
``` | ||
|
||
## ISBN | ||
If the result is 0, then it is a valid ISBN-10, otherwise it is invalid. | ||
|
||
## Example | ||
|
||
Let's take a random ISBN-10 number, say `3-598-21508-8` for this. | ||
The first digit block indicates the group where the ISBN belongs. Groups can consist of shared languages, geographic regions or countries. The leading '3' signals this ISBN is from a german speaking country. | ||
The following number block is to identify the publisher. Since this is a three digit publisher number there is a 5 digit title number for this book. | ||
The last digit in the ISBN is the check digit which is used to detect read errors. | ||
Let's take the ISBN-10 `3-598-21508-8`. We plug it in to the formula, and get: | ||
``` | ||
(3 * 10 + 5 * 9 + 9 * 8 + 8 * 7 + 2 * 6 + 1 * 5 + 5 * 4 + 0 * 3 + 8 * 2 + 8 * 1) mod 11 == 0 | ||
``` | ||
|
||
The first 9 digits in the ISBN have to be between 0 and 9. | ||
The check digit can additionally be an 'X' to allow 10 to be a valid check digit as well. | ||
Since the result is 0, this proves that our ISBN is valid. | ||
|
||
## Task | ||
|
||
Given a string the program should check if the provided string is a valid ISBN-10. | ||
Putting this into place requires some thinking about preprocessing/parsing of the string prior to calculating the check digit for the ISBN. | ||
|
||
A valid ISBN-10 is calculated with this formula `(x1 * 10 + x2 * 9 + x3 * 8 + x4 * 7 + x5 * 6 + x6 * 5 + x7 * 4 + x8 * 3 + x9 * 2 + x10 * 1) mod 11 == 0` | ||
So for our example ISBN this means: | ||
(3 * 10 + 5 * 9 + 9 * 8 + 8 * 7 + 2 * 6 + 1 * 5 + 5 * 4 + 0 * 3 + 8 * 2 + 8 * 1) mod 11 = 0 | ||
The program should be able to verify ISBN-10 both with and without separating dashes. | ||
|
||
Which proves that the ISBN is valid. | ||
|
||
## Caveats | ||
|
||
Converting from string to number can be tricky in certain languages. | ||
It's getting even trickier since the check-digit of an ISBN-10 can be 'X'. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add an example valid ISBN with X as a check digit (from the canonical-data.json) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shall do! |
||
Converting from strings to numbers can be tricky in certain languages. | ||
Now, it's even trickier since the check digit of an ISBN-10 may be 'X' (representing '10'). For instance `3-598-21507-X` is a valid ISBN-10. | ||
|
||
## Bonus tasks | ||
|
||
* Generate a valid ISBN-13 from the input ISBN-10 (and maybe verify it again with a derived verifier) | ||
* Generate a valid ISBN-13 from the input ISBN-10 (and maybe verify it again with a derived verifier). | ||
|
||
* Generate valid ISBN, maybe even from a given starting ISBN | ||
* Generate valid ISBN, maybe even from a given starting ISBN. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While we're here: Line 8 is grammatically odd.
Also this is the first indication that there could be dashes in the number.
Maybe add an example number to the first paragraph.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done 👍