BinaryTree.java 0100600 0000764 0001001 00000033305 07725006072 014261 0 ustar Administrator None /** \file BinaryTree.java This Java binary tree search, insert and delete class is based on C++ source code with the copyright shown below. Surprisingly, the Java form of a binary tree that supports deletion is more complex than the C++ version.
This software was written by Ian L. Kaplan, Chief Fat Bear, Bear Products International. Use of this software, for any purpose, is granted on two conditions:
The source code for this class is formatted for both Doxygen and JavaDoc. Doxygen is available from http://www.doxygen.org. Doxygen is available for Linux, Solaris and even Windoz. To generate documentation do:
Doxygen: doxygen doxygenBinaryTree
Javadoc: javadoc -d
The Java class library includes the java.util.TreeMap class which is a balanced Red-Black tree which is recommended over this code. As with this class, the TreeMap class supports both insertion and deletion.
This class is not intended as a replacement for the TreeMap class. It was written to some degree as an excercise and demonstration. It uses a classic binary tree algorthm for both insert and delete. In contrast to the TreeMap algorithm, which uses left, right and parent references, this class uses only left and right references. As a result, this algorithm mirrors similar binary tree algorithms that might be implemented in C, C++, Pascal, or Modula-X.
This code is an interesting example of the problems that can be encountered in Java, where only pass-by-value is supported. The classic tree delete algorithm, which depends on pass by reference becomes much more awkward. A reference object is used in this code, which supports indirection. Since all references are made through the reference object, the code is more difficult to write and to understand that it would be for a language like C++ which supports reference arguments.
This object is not synchronized, so it is not safe for multi-threaded use.
*/ public class BinaryTree { /** A container for a reference */ private class NodeReference { NodeReference() { ref = null; } public Node ref; } // class NodeReference /** A binary tree node, where the associated data item is a generic Object. */ private class Node { /** key/data object associated with this node */ private Object mObj; /** Reference object for the left link */ private NodeReference mLeft; /** Reference object for the right link */ private NodeReference mRight; /** Initialize the left and right links */ private void init() { mLeft = new NodeReference(); mRight = new NodeReference(); } /** When a Node is created, it is constructed with a left and right reference object. The left and right reference objects are unchangable, although what they point to can be changed (see setLeft() and setRight() below). */ public Node( Object obj ) { mObj = obj; init(); } /** get the Object associated with the Node */ public Object getObj() { return mObj; } /** get a reference to the left branch */ public NodeReference getLeftRef() { return mLeft; } /** get a reference to the right branch */ public NodeReference getRightRef() { return mRight; } /** get the Node on the left branch */ public Node getLeft() { return mLeft.ref; } /** set the Node on the left branch */ public void setLeft( Node left ) { mLeft.ref = left; } /** get the Node on the right branch */ public Node getRight() { return mRight.ref; } /** set the Node on the right branch */ public void setRight( Node right ) { mRight.ref = right; } } // Node /** root of the binary tree */ private NodeReference root; /** Number of nodes in the binary tree */ private int mNodeCount; /** Object used to compare Objects in the tree */ private Comparator mCompare; /** The constructor is initialized with an instance of the Comparator interface, which supports the compare() method which is used to compare objects in the tree with a search key. The equals() method of the Comparator interface is not used and should return false. */ public BinaryTree( Comparator compareObj ) { root = new NodeReference(); mNodeCount = 0; mCompare = compareObj; } // BinaryTree /** When a value is removed from an ordered binary tree and the value has two children, it will be replaced by the next value in the right sub-branch which is greater. This value will be the last (leaf) value in the left branch of the right branch sub-tree. The right sub-tree node is the argument to this function.The unlink function walks down a sub-tree's left branch until it gets to the end (the leaf node). It removes the value at the end of the branch and returns it (so it can be inserted into the "hole" left by the deleted value). If the value at the end of the left branch has a right branch child, this value replaces the terminal left branch node.
@return either the Node referenced by root (if root has no left branch) or the Node at the end of the left branch. */ private Node unlink( NodeReference root ) { Node treeNode = null; NodeReference nodeRef; // move down the left branch, until the object pointed to by the node // reference has a null link. for (nodeRef = root; nodeRef.ref.getLeft() != null; nodeRef = nodeRef.ref.getLeftRef()) { /* nada */; } treeNode = nodeRef.ref; if (nodeRef.ref.getRight() != null) { nodeRef.ref = nodeRef.ref.getRight(); } else { nodeRef.ref = null; } return treeNode; } // unlink /** This function searches a binary tree for "key" and deletes the item from the tree if it found. The ordering of the tree is maintained (see below). If "key" is found, the Object will be returned. If "key" is not found, the function returns null.When the node is found in the tree there are three possible cases:
The tree is constructed of unique items. If an item is already present in the tree, key will not be inserted, even though insert may be true.
@param root the root of the current subtree. @param key this object contains the key value being searched for. @param insert if this flag is true, key will be inserted into the tree if it is not already present. @return if an object in the tree that matches key is found, return a reference to this object. Otherwise return null. */ private Object searchAndInsert( NodeReference root, Object key, boolean insert ) { Object retObj = null; if (root.ref == null && insert) { root.ref = new Node( key ); mNodeCount++; } else { // if root.ref.getObj() > key if (mCompare.compare(root.ref.getObj(), key) > 0) { searchAndInsert(root.ref.getLeftRef(), key, insert); // search left branch } // if root.ref.getObj() < key else if (mCompare.compare(root.ref.getObj(), key) < 0) { searchAndInsert(root.ref.getRightRef(), key, insert);// search right branch } else { // key == root.ref.getObj() retObj = root.ref.getObj(); } } return retObj; } // searchAndInsert /** Return a string consisting of count spaces. */ private String spaces( int count ) { String result = ""; if (count > 0) { StringBuffer buf = new StringBuffer(); for (int i = 0; i < count; i++) { buf.append(' '); } result = buf.toString(); } return result; } // spaces /** Recursively build up a "landscape" display for the tree (e.g., a tree running down the page). When one of the children of a node is null (but not both) a null is added so that it is possible to see whether a child is a left or right child. */ private void toString( NodeReference root, PrintStream ps, int indent ) { ps.print( spaces(indent) ); ps.println( root.ref.getObj().toString() ); if (root.ref.getLeft() != null) { toString( root.ref.getLeftRef(), ps, indent+4 ); } else if (root.ref.getRight() != null) { ps.println( spaces(indent+4) + "null" ); } if (root.ref.getRight() != null) { toString( root.ref.getRightRef(), ps, indent+4 ); } else if (root.ref.getLeft() != null) { ps.println( spaces(indent+4) + "null" ); } } // toString /** Return a String which contains the tree represented in "landscape" form, running down the page. The tree children are indented from the parents to show the tree structure. */ public String toString() { ByteArrayOutputStream bos = new ByteArrayOutputStream(); PrintStream ps = new PrintStream( bos ); toString(root, ps, 0); return bos.toString(); } // toString /** Recursively traverse the tree (using inorder tranversal) and insert the Objects from the tree into a Vector. */ private void toArray( Node root, Vector vec ) { if (root != null) { toArray( root.getLeft(), vec ); vec.add( root.getObj() ); toArray( root.getRight(), vec ); } } // toArray /** Return an ordered array of tree objects, where Object values (as determined by the Comparator object used to initialize the BinaryTree constructor) increase with the array indices (e.g., the smallest value is at index 0, the largest value is at index n. */ public Object[] toArray() { Vector vec = new Vector(); toArray( root.ref, vec ); return vec.toArray(); } /** Insert an object in the tree if it is not already present. @return if the object is not found in the tree, return null. Otherwise return the object in the tree. */ public Object insert( Object newObj ) { Object foundObj = searchAndInsert( root, newObj, true ); return foundObj; } // insert /** Search for an object in the tree that compares equal to key. @return If the object is found in the tree, return a reference to the object. Otherwise return null. */ public Object search( Object key ) { Object foundObj = searchAndInsert( root, key, false ); return foundObj; } // search /** Search the tree for an object which compares equal to key. If the object is found, delete it. */ public Object delete( Object key ) { Object foundObj = delete( root, key ); return foundObj; } // delete /** Return the number of data items (Objects) in the tree */ public int size() { return mNodeCount; } } // class BinaryTree TreeTest.java 0100600 0000764 0001001 00000007606 07724525742 013772 0 ustar Administrator None import java.util.Vector; import java.util.Comparator; import java.util.Random; /** Unit test for the BinaryTree class */ class TreeTest { /** An ordered version of the Vector object. */ private class OrderedVector extends Vector { public OrderedVector() { super(); } /** Override the Vector add(Object) method.The method implements and ordered insert. All elements in the ordered vector are unique (so if the Integer is found in the Vector it will not be added).
This algorithm has an N2 worst case time complexity so it is not designed for efficiency.
*/ public boolean add( Object obj ) { Integer newInt = (Integer)obj; int len = size(); boolean found = false; int i; for (i = 0; i < len; i++) { Integer intObj = (Integer)elementAt( i ); if (newInt.compareTo( intObj ) > 0) { continue; } else { if (newInt.compareTo( intObj ) == 0) { found = true; } break; } } // for if (i == len) { addElement( newInt ); } else if (!found) { insertElementAt( newInt, i ); } return true; } // add } // OrderedVector /** An object to compare two Integer objects. An instance of this object is used to initialize a BinaryTree object. */ private class IntegerComparator implements Comparator { public int compare( Object lhs, Object rhs ) { int result = ((Integer)lhs).compareTo((Integer)rhs); return result; } public boolean equals( Object obj ) { return false; } } private boolean equals( Object[] treeArray, OrderedVector ordVec ) { boolean rslt = true; if (ordVec.size() != treeArray.length) { rslt = false; } else { for (int i = 0; i < treeArray.length; i++) { Integer i1 = (Integer)treeArray[i]; Integer i2 = (Integer)ordVec.elementAt(i); if (i1.compareTo(i2) != 0) { rslt = false; break; } } } return rslt; } // equals /** Test that values in the BinaryTree object are ordered properly and that object delete works properly. This test builds an ordered Vector which mirrors the ordered contents of the binary tree. Elements are removed from the tree and from the ordered vector. A check is then made that both the ordered vector and the contents of the tree are the same. This is a test, so no thought is given to efficiency. */ private void treeTest() { Random rand = new Random( 127 ); IntegerComparator compare = new IntegerComparator(); BinaryTree tree = new BinaryTree( compare ); final int INT_RANGE = 0xffff; final int NUM_VALS = 256; OrderedVector ordVec = new OrderedVector(); for (int i = 0; i < NUM_VALS; i++) { int iRand = rand.nextInt( INT_RANGE ); Integer I = new Integer( iRand ); tree.insert( I ); ordVec.add( I ); } // for if (!equals(tree.toArray(), ordVec)) { System.out.println("Initially, tree array and ordered vector are not equal"); } else { final int NUM_TO_REMOVE = NUM_VALS / 2; boolean testPassed = true; int count = 0; while (count < NUM_TO_REMOVE) { int range = ordVec.size(); int index = rand.nextInt( range ); Integer intObj = (Integer)ordVec.elementAt( index ); ordVec.remove( index ); tree.delete( intObj ); if (!equals(tree.toArray(), ordVec)) { testPassed = false; break; } count++; } // while if (testPassed) { System.out.println("Test passed"); } else { System.out.println("Test failed"); System.out.println("count = " + count ); } } } public static void main( String argv[] ) { TreeTest test = new TreeTest(); test.treeTest(); } } doxygenBinaryTree 0100700 0000764 0001001 00000131226 07725003726 014744 0 ustar Administrator None # Doxyfile 1.3.3 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # General configuration options #--------------------------------------------------------------------------- # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = BinaryTree # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = doxygenDoc # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English # This tag can be used to specify the encoding used in the generated output. # The encoding is not always determined by the language that is chosen, # but also whether or not the output is meant for Windows or non-Windows users. # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES # forces the Windows encoding (this is the default for the Windows binary), # whereas setting the tag to NO uses a Unix-style encoding (the default for # all platforms other than Windows). USE_WINDOWS_ENCODING = YES # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = YES # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited # members of a class in the documentation of that class as if those members were # ordinary class members. Constructors, destructors and assignment operators of # the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. It is allowed to use relative paths in the argument list. STRIP_FROM_PATH = # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # users are advised to set this option to NO. CASE_SENSE_NAMES = YES # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like the Qt-style comments (thus requiring an # explict @brief command for a brief description. JAVADOC_AUTOBRIEF = YES # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. # If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = YES # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # reimplements. INHERIT_DOCS = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources # only. Doxygen will then generate output that is more tailored for Java. # For instance, namespaces will be presented as packages, qualified scopes # will look different, etc. OPTIMIZE_OUTPUT_JAVA = YES # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp # *.h++ *.idl *.odl *.cs FILE_PATTERNS = TreeTest.java BinaryTree.java # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories # that are symbolic links (a Unix filesystem feature) are excluded from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. EXCLUDE_PATTERNS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command