Fix JavaDoc errors

This commit is contained in:
Phyks (Lucas Verney) 2018-12-04 17:23:28 +01:00
parent d621964863
commit 780e865870
14 changed files with 124 additions and 128 deletions

View file

@ -4,8 +4,8 @@ package btools.codec;
* Encoder/Decoder for signed integers that automatically detects the typical
* 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

View file

@ -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
@ -124,9 +124,9 @@ public final class TagValueCoder
break;
}
inum += delta;
int data = bc.decodeVarBits();
if ( validator == null || validator.isLookupIdxUsed( inum ) )
{
hasdata = true;

View file

@ -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)
{

View file

@ -28,12 +28,12 @@ public abstract class BExpressionContext implements IByteArrayUnifier
{
private static final String CONTEXT_TAG = "---context:";
private static final String MODEL_TAG = "---model:";
private String context;
private boolean _inOurContext = false;
private BufferedReader _br = null;
private boolean _readerDone = false;
public String _modelClass;
private Map<String,Integer> lookupNumbers = new HashMap<String,Integer>();
@ -49,7 +49,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
private byte[] abBuf = new byte[256];
private BitCoderContext ctxEndode = new BitCoderContext( abBuf );
private BitCoderContext ctxDecode = new BitCoderContext( new byte[0] );
private Map<String,Integer> variableNumbers = new HashMap<String,Integer>();
private float[] variableData;
@ -69,12 +69,12 @@ public abstract class BExpressionContext implements IByteArrayUnifier
// build-in variable indexes for fast access
private int[] buildInVariableIdx;
private int nBuildInVars;
private float[] currentVars;
private int currentVarOffset;
private BExpressionContext foreignContext;
protected void setInverseVars()
{
currentVarOffset = nBuildInVars;
@ -82,7 +82,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
abstract String[] getBuildInVariableNames();
public final float getBuildInVariable( int idx )
public final float getBuildInVariable( int idx )
{
return currentVars[idx+currentVarOffset];
}
@ -107,11 +107,11 @@ public abstract class BExpressionContext implements IByteArrayUnifier
{
this.context = context;
this.meta = meta;
if ( meta != null ) meta.registerListener(context, this );
if ( Boolean.getBoolean( "disableExpressionCache" ) ) hashSize = 1;
// create the expression cache
if ( hashSize > 0 )
{
@ -133,12 +133,12 @@ public abstract class BExpressionContext implements IByteArrayUnifier
{
BitCoderContext ctx = ctxEndode;
ctx.reset();
int skippedTags = 0;
int nonNullTags= 0;
// (skip first bit ("reversedirection") )
// all others are generic
for( int inum = 1; inum < lookupValues.size(); inum++ ) // loop over lookup names
{
@ -151,29 +151,29 @@ public abstract class BExpressionContext implements IByteArrayUnifier
ctx.encodeVarBits( skippedTags+1 );
nonNullTags++;
skippedTags = 0;
// 0 excluded already, 1 (=unknown) we rotate up to 8
// to have the good code space for the popular values
int dd = d < 2 ? 7 : ( d < 9 ? d - 2 : d - 1);
ctx.encodeVarBits( dd );
}
ctx.encodeVarBits( 0 );
if ( nonNullTags == 0) return null;
int len = ctx.getEncodedLength();
byte[] ab = new byte[len];
System.arraycopy( abBuf, 0, ab, 0, len );
// crosscheck: decode and compare
int[] ld2 = new int[lookupValues.size()];
decode( ld2, false, ab );
for( int inum = 1; inum < lookupValues.size(); inum++ ) // loop over lookup names (except reverse dir)
{
if ( ld2[inum] != ld[inum] ) throw new RuntimeException( "assertion failed encoding inum=" + inum + " val=" + ld[inum] + " " + getKeyValueDescription(false, ab) );
}
}
return ab;
}
@ -186,7 +186,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
decode( lookupData, false, ab );
lookupDataValid = true;
}
/**
@ -196,10 +196,10 @@ public abstract class BExpressionContext implements IByteArrayUnifier
{
BitCoderContext ctx = ctxDecode;
ctx.reset( ab );
// start with first bit hardwired ("reversedirection")
ld[0] = inverseDirection ? 2 : 0;
// all others are generic
int inum = 1;
for(;;)
@ -207,7 +207,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
int delta = ctx.decodeVarBits();
if ( delta == 0) break;
if ( inum + delta > ld.length ) break; // higher minor version is o.k.
while ( delta-- > 1 ) ld[inum++] = 0;
// see encoder for value rotation
@ -255,7 +255,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
private int parsedLines = 0;
private boolean fixTagsWritten = false;
public void parseMetaLine( String line )
{
parsedLines++;
@ -278,7 +278,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
// add aliases
while( newValue != null && tk.hasMoreTokens() ) newValue.addAlias( tk.nextToken() );
}
public void finishMetaParsing()
{
if ( parsedLines == 0 && !"global".equals(context) )
@ -288,7 +288,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
// post-process metadata:
lookupDataFrozen = true;
lookupIdxUsed = new boolean[lookupValues.size()];
}
@ -310,12 +310,12 @@ public abstract class BExpressionContext implements IByteArrayUnifier
private long requests;
private long requests2;
private long cachemisses;
public String cacheStats()
{
return "requests=" + requests + " requests2=" + requests2 + " cachemisses=" + cachemisses;
}
private CacheNode lastCacheNode = new CacheNode();
// @Override
@ -355,7 +355,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
{
requests++;
lookupDataValid = false; // this is an assertion for a nasty pifall
if ( cache == null )
{
decode( lookupData, inverseDirection, ab );
@ -383,7 +383,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
if ( cn == null )
{
cachemisses++;
cn = (CacheNode)cache.removeLru();
if ( cn == null )
{
@ -405,9 +405,9 @@ public abstract class BExpressionContext implements IByteArrayUnifier
// inverse direction
lookupData[0] = 2; // inverse shortcut: reuse decoding
evaluateInto( probeVarSet.vars, nBuildInVars );
probeVarSet.hash = Arrays.hashCode( probeVarSet.vars );
// unify the result variable set
VarWrapper vw = (VarWrapper)resultVarCache.get( probeVarSet );
if ( vw == null )
@ -427,7 +427,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
else
{
if ( ab == cn.ab ) requests2++;
cache.touch( cn );
}
@ -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, &gt; 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
*/
@ -680,7 +680,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
Integer num = lookupNumbers.get( name );
return num != null && lookupData[num.intValue()] == 2;
}
public int getOutputVariableIndex( String name, boolean mustExist )
{
int idx = getVariableIdx( name, false );
@ -708,7 +708,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
buildInVariableIdx = extended;
return nBuildInVars++;
}
public void setForeignContext( BExpressionContext foreignContext )
{
this.foreignContext = foreignContext;
@ -855,7 +855,7 @@ public abstract class BExpressionContext implements IByteArrayUnifier
{
lookupIdxUsed[ idx ] = true;
}
public final boolean isLookupIdxUsed( int idx )
{
return idx < lookupIdxUsed.length ? lookupIdxUsed[idx] : false;

View file

@ -14,7 +14,7 @@ public final class BitReadBuffer
this.ab = ab;
idxMax = ab.length-1;
}
public boolean decodeBit()
{
fillBuffer();
@ -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()
{
@ -139,7 +139,7 @@ public final class BitReadBuffer
}
}
private void fillBuffer()
{
while (bits <= 56)
@ -150,5 +150,5 @@ public final class BitReadBuffer
}
bits += 8;
}
}
}
}

View file

@ -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.
*
* @see #decodeVarBits
* {@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
*
*/
public void encodeInt( int value )
{
@ -39,7 +40,7 @@ public final class BitWriteBuffer
value -= range + 1;
range = 2 * range + 1;
}
encodeBit( true );
encodeBounded( range, value );
}
@ -127,7 +128,7 @@ public final class BitWriteBuffer
if ( size == 0 )
{
return;
}
}
long maxValue = values[size-1];
int nbits = 0;
while ( maxValue > 0 )
@ -187,7 +188,7 @@ public final class BitWriteBuffer
/**
* assign the de-/encoded bits since the last call assignBits to the given
* name. Used for encoding statistics
*
*
* @see #getBitReport
*/
public void assignBits( String name )
@ -210,7 +211,7 @@ public final class BitWriteBuffer
/**
* Get a textual report on the bit-statistics
*
*
* @see #assignBits
*/
public static String getBitReport()

View file

@ -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 -&gt; statistics -&gt; encoding )
* but doesn't do anything at pass1
*/
public abstract class HuffmanTreeEncoder<V>
@ -124,10 +124,10 @@ public abstract class HuffmanTreeEncoder<V>
}
}
}
@Override
public boolean equals( Object o )
{
{
return itemEquals( ((TreeNode)o).data, data );
}

View file

@ -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 -&gt; statistics -&gt; encoding )
* but doesn't do anything at pass1
*/
public final class TagSetEncoder
@ -131,7 +131,7 @@ public final class TagSetEncoder
}
}
}
@Override
public boolean equals( Object o )
{

View file

@ -13,11 +13,11 @@ import java.util.HashMap;
import java.util.List;
/**
* URL query parameter handler for web and standalone server. Supports all
* URL query parameter handler for web and standalone server. Supports all
* BRouter features without restrictions.
*
*
* Parameters:
*
*
* lonlats = lon,lat|... (unlimited list of lon,lat waypoints separated by |)
* nogos = lon,lat,radius|... (optional, radius in meters)
* profile = profile file name without .brf
@ -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 {
@ -59,7 +59,7 @@ public class ServerHandler extends RequestHandler {
rc.localFunction = profile;
rc.setAlternativeIdx(Integer.parseInt(params.get( "alternativeidx" )));
List<OsmNodeNamed> nogoList = readNogoList();
List<OsmNodeNamed> nogoPolygonsList = readNogoPolygons();
@ -89,14 +89,14 @@ public class ServerHandler extends RequestHandler {
if (lonLats == null) throw new IllegalArgumentException( "lonlats parameter not set" );
String[] coords = lonLats.split("\\|");
if (coords.length < 2)
if (coords.length < 2)
throw new IllegalArgumentException( "we need two lat/lon points at least!" );
List<OsmNodeNamed> wplist = new ArrayList<OsmNodeNamed>();
for (int i = 0; i < coords.length; i++)
{
String[] lonLat = coords[i].split(",");
if (lonLat.length < 2)
if (lonLat.length < 2)
throw new IllegalArgumentException( "we need two lat/lon points at least!" );
wplist.add( readPosition( lonLat[0], lonLat[1], "via" + i ) );
}
@ -106,7 +106,7 @@ public class ServerHandler extends RequestHandler {
return wplist;
}
@Override
public String formatTrack(OsmTrack track)
{
@ -175,7 +175,7 @@ public class ServerHandler extends RequestHandler {
result = "text/tab-separated-values";
}
}
return result;
}
@ -197,10 +197,10 @@ public class ServerHandler extends RequestHandler {
{
if ( vlon == null ) throw new IllegalArgumentException( "lon " + name + " not found in input" );
if ( vlat == null ) throw new IllegalArgumentException( "lat " + name + " not found in input" );
return readPosition(Double.parseDouble( vlon ), Double.parseDouble( vlat ), name);
}
private static OsmNodeNamed readPosition( double lon, double lat, String name )
{
OsmNodeNamed n = new OsmNodeNamed();
@ -209,7 +209,7 @@ public class ServerHandler extends RequestHandler {
n.ilat = (int)( ( lat + 90. ) *1000000. + 0.5);
return n;
}
private List<OsmNodeNamed> readNogoList()
{
// lon,lat,radius|...
@ -227,7 +227,7 @@ public class ServerHandler extends RequestHandler {
return nogoList;
}
private static OsmNodeNamed readNogo( String lon, String lat, String radius )
{
return readNogo(Double.parseDouble( lon ), Double.parseDouble( lat ), Integer.parseInt( radius ) );
@ -250,7 +250,7 @@ public class ServerHandler extends RequestHandler {
parseNogoPolygons( params.get("polygons"), result, true );
return result.size() > 0 ? result : null;
}
private static void parseNogoPolygons(String polygons, List<OsmNodeNamed> result, boolean closed )
{
if ( polygons != null )
@ -277,6 +277,6 @@ public class ServerHandler extends RequestHandler {
}
}
}
}
}
}
}

View file

@ -15,13 +15,13 @@ public class BitCoderContext
this.ab = ab;
idxMax = ab.length-1;
}
public final void reset( byte[] ab )
{
this.ab = ab;
idxMax = ab.length-1;
reset();
}
}
public final void reset()
{
@ -29,16 +29,16 @@ public class BitCoderContext
bm = 0x100;
bits = 0;
b = 0;
}
}
/**
* 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
*/
public final void encodeVarBits( int value )
@ -175,7 +175,7 @@ public class BitCoderContext
bits -= count;
return value;
}
private void fillBuffer()
{
while (bits < 24)
@ -186,7 +186,7 @@ public class BitCoderContext
}
bits += 8;
}
}
}
/**
* @return the encoded length in bytes

View file

@ -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 )

View file

@ -49,9 +49,9 @@ public final class CheapRulerSingleton {
}
/**
* Calculate the degree->meter scale for given latitude
* Calculate the degree-&gt;meter scale for given latitude
*
* @result [lon-&gt;meter,lat-&gt;meter]
* @return [lon-&gt;meter,lat-&gt;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 );

View file

@ -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()
{
@ -85,7 +83,7 @@ public class DenseLongMap
while (blocklist.size() < blockn+1 )
{
blocklist.add(null);
}
}
blocklist.set( blockn, block );
}
else
@ -99,7 +97,7 @@ public class DenseLongMap
int headersize = 1 << valuebits;
byte v = (byte)(value + 1); // 0 is reserved (=unset)
// find the index in the lookup table or the first entry
int idx = 1;
while( idx < headersize )
@ -122,7 +120,7 @@ public class DenseLongMap
valuebits++;
headersize = 1 << valuebits;
}
int bitmask = 1 << (offset & 0x7);
int invmask = bitmask ^ 0xff;
int probebit = 1;
@ -149,7 +147,7 @@ public class DenseLongMap
// size is lookup table + datablocks
return ( 1 << bits ) + blocksize * bits;
}
private byte[] expandBlock( byte[] block, int valuebits )
{
bitplaneCount[valuebits] ++;
@ -204,7 +202,7 @@ public class DenseLongMap
{
return -1;
}
// check how many bitplanes we have from the arrayzize
int valuebits = 1;
while( sizeForBits( valuebits) < block.length )
@ -212,7 +210,7 @@ public class DenseLongMap
valuebits++;
}
int headersize = 1 << valuebits;
int bitmask = 1 << (offset & 7);
int probebit = 1;
int blockidx = (offset >> 3) + headersize;

View file

@ -4,7 +4,7 @@ import java.util.Random;
/**
* Memory efficient and lightning fast heap to get the lowest-key value of a set of key-object pairs
*
*
* @author ab
*/
public final class SortedHeap<V>
@ -54,7 +54,7 @@ public final class SortedHeap<V>
Object[] vla; // value array
int lv; // low value
int lp; // low pointer
SortedBin( int binsize, SortedHeap parent )
{
this.binsize = binsize;
@ -63,7 +63,7 @@ public final class SortedHeap<V>
vla = new Object[binsize];
lp = binsize;
}
SortedBin next()
{
if ( next == null )
@ -108,7 +108,7 @@ public final class SortedHeap<V>
neBin = next;
}
}
void add( int key, Object value )
{
int p = lp;
@ -126,17 +126,15 @@ public final class SortedHeap<V>
p++;
}
}
}
/**
* 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 )
{
@ -164,16 +162,16 @@ public final class SortedHeap<V>
first.nextNonEmpty = second;
}
}
}
private void sortUp()
{
if ( size > peaksize )
{
peaksize = size;
}
// determine the first array big enough to take them all
int cnt = 8; // value count of first 2 bins is always 8
SortedBin tbin = second; // target bin
@ -193,10 +191,10 @@ public final class SortedHeap<V>
int[] al_t = tbin.al;
Object[] vla_t = tbin.vla;
int tp = tbin.binsize-cnt; // target pointer
// unlink any higher, non-empty arrays
SortedBin otherNonEmpty = lastNonEmpty.nextNonEmpty;
lastNonEmpty.nextNonEmpty = null;
lastNonEmpty.nextNonEmpty = null;
// now merge the content of these non-empty bins into the target bin
while( firstNonEmpty != null )
@ -215,7 +213,7 @@ public final class SortedHeap<V>
}
// current minimum found, copy to target array
al_t[tp] = minId;
al_t[tp] = minId;
vla_t[tp++] = minBin.dropLowest();
}
@ -233,7 +231,7 @@ public final class SortedHeap<V>
second = new SortedBin( 4, this );
firstNonEmpty = null;
}
public int getSize()
{
return size;
@ -267,7 +265,7 @@ public final class SortedHeap<V>
}
return tp;
}
public static void main(String[] args)
{
SortedHeap<String> sh = new SortedHeap<String>();
@ -296,6 +294,6 @@ System.out.println( "popLowestKeyValue: " + val);
// Assert.assertTrue( "total count test", cnt == 100000 );
}
}