Fix JavaDoc errors
This commit is contained in:
Phyks (Lucas Verney)
parent
d621964863
commit
780e865870
14 changed files with 124 additions and 128 deletions
|
|
@ -5,7 +5,7 @@ package btools.codec;
|
|||
* range of these numbers to determine a noisy-bit count as a very simple
|
||||
* dictionary
|
||||
*
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* but doesn't do anything at pass1
|
||||
*/
|
||||
public final class NoisyDiffCoder
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import btools.util.BitCoderContext;
|
|||
* It detects identical descriptions and sorts them
|
||||
* into a huffman-tree according to their frequencies
|
||||
*
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* but doesn't do anything at pass1
|
||||
*/
|
||||
public final class TagValueCoder
|
||||
|
|
|
|||
|
|
@ -109,7 +109,6 @@ public class OsmNogoPolygon extends OsmNodeNamed
|
|||
double dlat2m = lonlat2m[1];
|
||||
|
||||
double rad = 0; // radius
|
||||
double rad2 = 0; // radius squared;
|
||||
|
||||
double dmax = 0; // length of vector from center to point
|
||||
int i_max = -1;
|
||||
|
|
@ -246,10 +245,9 @@ public class OsmNogoPolygon extends OsmNodeNamed
|
|||
/**
|
||||
* winding number test for a point in a polygon
|
||||
*
|
||||
* @param p a point
|
||||
* @param v list of vertex points forming a polygon. This polygon
|
||||
* is implicitly closed connecting the last and first point.
|
||||
* @return the winding number (=0 only when P is outside)
|
||||
* @param px longitude of the point to check
|
||||
* @param py latitude of the point to check
|
||||
* @return a boolean whether the point is within the polygon or not.
|
||||
*/
|
||||
public boolean isWithin(final long px, final long py)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -647,7 +647,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
|
|||
|
||||
/**
|
||||
* special hack for yes/proposed relations:
|
||||
* add a lookup value if not yet a smaller, >1 value was added
|
||||
* add a lookup value if not yet a smaller, > 1 value was added
|
||||
* add a 2=yes if the provided value is out of range
|
||||
* value-index means here 0=unknown, 1=other, 2=yes, 3=proposed
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -60,10 +60,10 @@ public final class BitReadBuffer
|
|||
/**
|
||||
* decode a small number with a variable bit length
|
||||
* (poor mans huffman tree)
|
||||
* 1 -> 0
|
||||
* 01 -> 1 + following 1-bit word ( 1..2 )
|
||||
* 001 -> 3 + following 2-bit word ( 3..6 )
|
||||
* 0001 -> 7 + following 3-bit word ( 7..14 ) etc.
|
||||
* {@code 1 -> 0}
|
||||
* {@code 01 -> 1} + following 1-bit word ( 1..2 )
|
||||
* {@code 001 -> 3} + following 2-bit word ( 3..6 )
|
||||
* {@code 0001 -> 7} + following 3-bit word ( 7..14 ) etc.
|
||||
*/
|
||||
public int decodeInt()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -23,12 +23,13 @@ public final class BitWriteBuffer
|
|||
/**
|
||||
* encode a distance with a variable bit length
|
||||
* (poor mans huffman tree)
|
||||
* 1 -> 0
|
||||
* 01 -> 1 + following 1-bit word ( 1..2 )
|
||||
* 001 -> 3 + following 2-bit word ( 3..6 )
|
||||
* 0001 -> 7 + following 3-bit word ( 7..14 ) etc.
|
||||
* {@code 1 -> 0}
|
||||
* {@code 01 -> 1} + following 1-bit word ( 1..2 )
|
||||
* {@code 001 -> 3} + following 2-bit word ( 3..6 )
|
||||
* {@code 0001 -> 7} + following 3-bit word ( 7..14 ) etc.
|
||||
*
|
||||
* @see btools.util.BitCoderContext#decodeVarBits
|
||||
*
|
||||
* @see #decodeVarBits
|
||||
*/
|
||||
public void encodeInt( int value )
|
||||
{
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ import java.util.PriorityQueue;
|
|||
* It detects identical sets and sorts them
|
||||
* into a huffman-tree according to their frequencies
|
||||
*
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* but doesn't do anything at pass1
|
||||
*/
|
||||
public abstract class HuffmanTreeEncoder<V>
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ import java.util.PriorityQueue;
|
|||
* It detects identical sets and sorts them
|
||||
* into a huffman-tree according to their frequencies
|
||||
*
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* Adapted for 3-pass encoding (counters -> statistics -> encoding )
|
||||
* but doesn't do anything at pass1
|
||||
*/
|
||||
public final class TagSetEncoder
|
||||
|
|
|
|||
|
|
@ -25,8 +25,8 @@ import java.util.List;
|
|||
* format = [kml|gpx|geojson] (optional, default gpx)
|
||||
*
|
||||
* Example URLs:
|
||||
* http://localhost:17777/brouter?lonlats=8.799297,49.565883|8.811764,49.563606&nogos=&profile=trekking&alternativeidx=0&format=gpx
|
||||
* http://localhost:17777/brouter?lonlats=1.1,1.2|2.1,2.2|3.1,3.2|4.1,4.2&nogos=-1.1,-1.2,1|-2.1,-2.2,2&profile=shortest&alternativeidx=1&format=kml
|
||||
* {@code http://localhost:17777/brouter?lonlats=8.799297,49.565883|8.811764,49.563606&nogos=&profile=trekking&alternativeidx=0&format=gpx}
|
||||
* {@code http://localhost:17777/brouter?lonlats=1.1,1.2|2.1,2.2|3.1,3.2|4.1,4.2&nogos=-1.1,-1.2,1|-2.1,-2.2,2&profile=shortest&alternativeidx=1&format=kml}
|
||||
*
|
||||
*/
|
||||
public class ServerHandler extends RequestHandler {
|
||||
|
|
|
|||
|
|
@ -34,10 +34,10 @@ public class BitCoderContext
|
|||
/**
|
||||
* encode a distance with a variable bit length
|
||||
* (poor mans huffman tree)
|
||||
* 1 -> 0
|
||||
* 01 -> 1 + following 1-bit word ( 1..2 )
|
||||
* 001 -> 3 + following 2-bit word ( 3..6 )
|
||||
* 0001 -> 7 + following 3-bit word ( 7..14 ) etc.
|
||||
* {@code 1 -> 0}
|
||||
* {@code 01 -> 1} + following 1-bit word ( 1..2 )
|
||||
* {@code 001 -> 3} + following 2-bit word ( 3..6 )
|
||||
* {@code 0001 -> 7} + following 3-bit word ( 7..14 ) etc.
|
||||
*
|
||||
* @see #decodeVarBits
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ public final class ByteArrayUnifier implements IByteArrayUnifier
|
|||
* Unify a byte array in order to reuse instances when possible.
|
||||
* The byte arrays are assumed to be treated as immutable,
|
||||
* allowing the reuse
|
||||
* @param the byte array to unify
|
||||
* @param ab the byte array to unify
|
||||
* @return the cached instance or the input instanced if not cached
|
||||
*/
|
||||
public byte[] unify( byte[] ab )
|
||||
|
|
|
|||
|
|
@ -49,9 +49,9 @@ public final class CheapRulerSingleton {
|
|||
}
|
||||
|
||||
/**
|
||||
* Calculate the degree->meter scale for given latitude
|
||||
* Calculate the degree->meter scale for given latitude
|
||||
*
|
||||
* @result [lon->meter,lat->meter]
|
||||
* @return [lon->meter,lat->meter]
|
||||
*/
|
||||
public static double[] getLonLatToMeterScales( int ilat ) {
|
||||
return SCALE_CACHE[ ilat / SCALE_CACHE_INCREMENT ];
|
||||
|
|
@ -67,8 +67,9 @@ public final class CheapRulerSingleton {
|
|||
* @param ilat2 Integer latitude for the end point, this is (latitude + 90) * 1e6.
|
||||
* @return The distance between the two points, in meters.
|
||||
*
|
||||
* @note Integer longitude is ((longitude in degrees) + 180) * 1e6.
|
||||
* Integer latitude is ((latitude in degrees) + 90) * 1e6.
|
||||
* Note:
|
||||
* Integer longitude is ((longitude in degrees) + 180) * 1e6.
|
||||
* Integer latitude is ((latitude in degrees) + 90) * 1e6.
|
||||
*/
|
||||
public static double distance(int ilon1, int ilat1, int ilon2, int ilat2) {
|
||||
double[] kxky = getLonLatToMeterScales( ( ilat1 + ilat2 ) >> 1 );
|
||||
|
|
|
|||
|
|
@ -31,8 +31,6 @@ public class DenseLongMap
|
|||
* Creates a DenseLongMap for the default block size
|
||||
* ( 512 bytes per bitplane, covering a key range of 4096 keys )
|
||||
* Note that one value range is limited to 0..254
|
||||
*
|
||||
* @param valuebits number of bits to use per value
|
||||
*/
|
||||
public DenseLongMap()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -133,10 +133,8 @@ public final class SortedHeap<V>
|
|||
/**
|
||||
* add a key value pair to the heap
|
||||
*
|
||||
* @param id
|
||||
* the key to insert
|
||||
* @param value
|
||||
* the value to insert object
|
||||
* @param key the key to insert
|
||||
* @param value the value to insert object
|
||||
*/
|
||||
public void add( int key, V value )
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in a new issue