HTMindex

All Known Implementing Classes:

HTMindexImp
```
public interface HTMindex
```
The HTMindex is the main interface for the HTM implementation. It provides the functionality called for in "Redesiging the HTM interface". The HTMindexImp provides an implementation of this. HTMfunc provides some of this funtionality albeit with different signatures. HTMindexImp uses HTMfunc where appropriate haence answers from the two should not differ.
```
  Current Version
  ===============
  ID:   $Id: HTMindex.java,v 1.2 2003/02/19 15:46:11 womullan Exp $
  Revision:     $Revision: 1.2 $
  Date/time:    $Date: 2003/02/19 15:46:11 $
 
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`area(String htmName)` give the area of the triangle secrad for HTM name given
`Domain`	`compliment(Domain d)` Return a new domain which contains everything not in the given domain
`boolean`	`contains(Domain d, Vector3d p)` does the domain coaintain thie given point
`double`	`distance(long htmId1, long htmId2)` angular distance between the two ids
`double`	`distance(String htmName1, String htmName2)` angular distance between the two names
`String`	`idToName(long htmId)` Convert id number to Symbolic name
`Vector3d`	`idToPoint(long htmId)` return center vector of the tringle which htmId relates to
`Vector3d`	`idToPoint(String htmName)` return center vector of the tringle which htmName relates to
`HTMrange`	`intersect(Domain d)` Return all HTMs which fall inside the given domain
`Domain`	`intersection(Domain d1, Domain d2)` Return a new domain contiainig common parts of the two domains
`String`	`lookup(double ra, double dec)` return a HTM name like N2121 for a given position
`String`	`lookup(Vector3d point)` return a HTM name like N2121 for a given vector
`long`	`lookupId(double ra, double dec)` return a HTM id number for a given position
`long`	`lookupId(Vector3d point)` return a HTM id number for a given vector
`long`	`nameToId(String name)` Convert Symbolic name to an id number
`Domain`	`simplify(Domain d)` return a HTM id number for a given position
`Domain`	`smooth(Domain d)` Perform lossy simplification of the domain
`Domain`	`union(Domain d1, Domain d2)` Return a new domain contiainig all parts of the two domains

- Method Detail
  - lookup
```
String lookup(Vector3d point)
       throws HTMException
```
    return a HTM name like N2121 for a given vector
    
    Throws:
    
    HTMException
  - lookup
```
String lookup(double ra,
              double dec)
       throws HTMException
```
    return a HTM name like N2121 for a given position
    
    Throws:
    
    HTMException
  - lookupId
```
long lookupId(Vector3d point)
       throws HTMException
```
    return a HTM id number for a given vector
    
    Throws:
    
    HTMException
  - lookupId
```
long lookupId(double ra,
              double dec)
       throws HTMException
```
    return a HTM id number for a given position
    
    Throws:
    
    HTMException
  - idToPoint
```
Vector3d idToPoint(long htmId)
            throws HTMException
```
    return center vector of the tringle which htmId relates to
    
    Throws:
    
    HTMException
  - idToPoint
```
Vector3d idToPoint(String htmName)
            throws HTMException
```
    return center vector of the tringle which htmName relates to
    
    Throws:
    
    HTMException
  - nameToId
```
long nameToId(String name)
       throws HTMException
```
    Convert Symbolic name to an id number
    
    Throws:
    
    HTMException
  - idToName
```
String idToName(long htmId)
         throws HTMException
```
    Convert id number to Symbolic name
    
    Throws:
    
    HTMException
  - simplify
```
Domain simplify(Domain d)
```
    return a HTM id number for a given position
  - area
```
double area(String htmName)
```
    give the area of the triangle secrad for HTM name given
  - contains
```
boolean contains(Domain d,
                 Vector3d p)
```
    does the domain coaintain thie given point
  - distance
```
double distance(long htmId1,
                long htmId2)
         throws HTMException
```
    angular distance between the two ids
    
    Throws:
    
    HTMException
  - distance
```
double distance(String htmName1,
                String htmName2)
         throws HTMException
```
    angular distance between the two names
    
    Throws:
    
    HTMException
  - intersect
```
HTMrange intersect(Domain d)
```
    Return all HTMs which fall inside the given domain
  - intersection
```
Domain intersection(Domain d1,
                    Domain d2)
```
    Return a new domain contiainig common parts of the two domains
  - union
```
Domain union(Domain d1,
             Domain d2)
```
    Return a new domain contiainig all parts of the two domains
  - compliment
```
Domain compliment(Domain d)
```
    Return a new domain which contains everything not in the given domain
  - smooth
```
Domain smooth(Domain d)
```
    Perform lossy simplification of the domain

Interface HTMindex

Method Summary

Method Detail

lookup

lookup

lookupId

lookupId

idToPoint

idToPoint

nameToId

idToName

simplify

area

contains

distance

distance

intersect

intersection

union

compliment

smooth