Skip to content

Commit e7fa878

Browse files
committed
Javadoc clean-up
1 parent eb56f0e commit e7fa878

File tree

106 files changed

+731
-596
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+731
-596
lines changed

src/com/jwetherell/algorithms/data_structures/AVLTree.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
* trees are more rigidly balanced, they are faster than red-black trees for
1313
* lookup intensive applications. However, red-black trees are faster for
1414
* insertion and removal.
15-
*
16-
* http://en.wikipedia.org/wiki/AVL_tree
17-
*
15+
* <p>
16+
* @see <a href="https://en.wikipedia.org/wiki/AVL_tree">AVL Tree (Wikipedia)</a>
17+
* <br>
1818
* @author Justin Wetherell <[email protected]>
1919
*/
2020
public class AVLTree<T extends Comparable<T>> extends BinarySearchTree<T> {

src/com/jwetherell/algorithms/data_structures/BTree.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
* two children. Unlike self-balancing binary search trees, the B-tree is
1515
* optimized for systems that read and write large blocks of data. It is
1616
* commonly used in databases and file-systems.
17-
*
18-
* http://en.wikipedia.org/wiki/B-tree
19-
*
17+
* <p>
18+
* @see <a href="https://en.wikipedia.org/wiki/B-tree">B-Tree (Wikipedia)</a>
19+
* <br>
2020
* @author Justin Wetherell <[email protected]>
2121
*/
2222
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/BinaryHeap.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
* the tree is not complete, the nodes of that level are filled from left to
1717
* right. 2) The heap property: each node is right than or equal to each of its
1818
* children according to a comparison predicate defined for the data structure.
19-
*
20-
* http://en.wikipedia.org/wiki/Binary_heap
21-
*
19+
* <p>
20+
* @see <a href="https://en.wikipedia.org/wiki/Binary_heap">Binary Heap (Wikipedia)</a>
21+
* <br>
2222
* @author Justin Wetherell <[email protected]>
2323
*/
2424
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/BinarySearchTree.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
* keys less than the node's key. 2) The right subtree of a node contains only
2020
* nodes with keys greater than the node's key. 3) Both the left and right
2121
* subtrees must also be binary search trees.
22-
*
23-
* http://en.wikipedia.org/wiki/Binary_search_tree
24-
*
22+
* <p>
23+
* @see <a href="https://en.wikipedia.org/wiki/Binary_search_tree">Binary Search Tree (Wikipedia)</a>
24+
* <br>
2525
* @author Justin Wetherell <[email protected]>
2626
*/
2727
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/CompactSuffixTrie.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
* string in a way that allows for a particularly fast implementation of many
99
* important string operations. This implementation is based upon a patricia
1010
* trie which IS a compact trie.
11-
*
12-
* http://en.wikipedia.org/wiki/Suffix_trie
13-
*
11+
* <p>
12+
* @see <a href="https://en.wikipedia.org/wiki/Suffix_trie">Suffix Trie (Wikipedia)</a>
13+
* <br>
1414
* @author Justin Wetherell <[email protected]>
1515
*/
1616
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/DisjointSet.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
/**
44
* In computer science, a disjoint-set data structure, also called a union–find data structure or merge–find set, is a data structure that keeps track of a set of
55
* elements partitioned into a number of disjoint (non-overlapping) subsets.
6-
*
7-
* It supports two useful operations:
6+
* <p>
7+
* It supports two useful operations:<br>
88
* Find: Determine which subset a particular element is in. Find typically returns an item from this set that serves as its "representative"; by comparing the
9-
* result of two Find operations, one can determine whether two elements are in the same subset.
10-
* Union: Join two subsets into a single subset.
11-
*
12-
* http://en.wikipedia.org/wiki/Disjoint-set_data_structure
13-
*
9+
* result of two Find operations, one can determine whether two elements are in the same subset.<br>
10+
* Union: Join two subsets into a single subset.<br>
11+
* <p>
12+
* @see <a href="https://en.wikipedia.org/wiki/Disjoint-set_data_structure">Disjoint Set (Wikipedia)</a>
13+
* <br>
1414
* @author Justin Wetherell <[email protected]>
1515
*/
1616
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/FenwickTree.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
* for calculation and manipulation of the prefix sums of a table of values. Fenwick trees
1111
* primarily solve the problem of balancing prefix sum calculation efficiency with element
1212
* modification efficiency.
13-
*
14-
* http://en.wikipedia.org/wiki/Fenwick_tree
15-
*
13+
* <p>
1614
* This class is meant to be somewhat generic, all you'd have to do is extend
1715
* the Data abstract class to store your custom data. I've included a range sum
1816
* implementations.
19-
*
17+
* <p>
18+
* @see <a href="https://en.wikipedia.org/wiki/Fenwick_tree">Fenwick Tree (Wikipedia)</a>
19+
* <br>
2020
* @author Justin Wetherell <[email protected]>
2121
*/
2222
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/Graph.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
* Graph. Could be directed or undirected depending on the TYPE enum. A graph is
1111
* an abstract representation of a set of objects where some pairs of the
1212
* objects are connected by links.
13-
*
14-
* http://en.wikipedia.org/wiki/Graph_(mathematics)
15-
*
13+
* <p>
14+
* @see <a href="https://en.wikipedia.org/wiki/Graph_(mathematics)">Graph (Wikipedia)</a>
15+
* <br>
1616
* @author Justin Wetherell <[email protected]>
1717
*/
1818
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/HashArrayMappedTrie.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
* A hash array mapped trie (HAMT) is an implementation of an associative
1111
* array that combines the characteristics of a hash table and an array mapped
1212
* trie. It is a refined version of the more general notion of a hash tree.
13-
*
13+
* <p>
1414
* This implementation is 32-bit and steps in 5-bit intervals, maximum tree
1515
* height of 7.
16-
*
17-
* http://en.wikipedia.org/wiki/Hash_array_mapped_trie
18-
*
16+
* <p>
17+
* @see <a href="https://en.wikipedia.org/wiki/Hash_array_mapped_trie">Hash Array Mapped Trie (Wikipedia)</a>
18+
* <br>
1919
* @author Justin Wetherell <[email protected]>
2020
*/
2121
@SuppressWarnings("unchecked")

src/com/jwetherell/algorithms/data_structures/HashMap.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
* Hash Map using either chaining or probing. hash map is a data structure that
1010
* uses a hash function to map identifying values, known as keys, to their
1111
* associated values.
12-
*
13-
* http://en.wikipedia.org/wiki/Hash_table
14-
*
12+
* <p>
13+
* @see <a href="https://en.wikipedia.org/wiki/Hash_table">Hash Map/Table (Wikipedia)</a>
14+
* <br>
1515
* @author Justin Wetherell <[email protected]>
1616
*/
1717
@SuppressWarnings("unchecked")

0 commit comments

Comments
 (0)