Merge pull request #1 from saurabhb17/develop

Added main functions

1 files changed, 181 insertions, 0 deletions

diff --git a/pcbnew/router/pns_optimizer.h b/pcbnew/router/pns_optimizer.h
new file mode 100644
index 0000000..36bced6
--- /dev/null
+++ b/pcbnew/router/pns_optimizer.h
@@ -0,0 +1,181 @@
+/*
+ * KiRouter - a push-and-(sometimes-)shove PCB router
+ *
+ * Copyright (C) 2013-2014 CERN
+ * Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __PNS_OPTIMIZER_H
+#define __PNS_OPTIMIZER_H
+
+#include <boost/unordered_map.hpp>
+#include <boost/shared_ptr.hpp>
+
+#include <geometry/shape_index_list.h>
+#include <geometry/shape_line_chain.h>
+
+#include "range.h"
+
+class PNS_NODE;
+class PNS_ROUTER;
+class PNS_LINE;
+class PNS_DIFF_PAIR;
+
+/**
+ * Class PNS_COST_ESTIMATOR
+ *
+ * Calculates the cost of a given line, taking corner angles and total length into account.
+ **/
+class PNS_COST_ESTIMATOR
+{
+public:
+    PNS_COST_ESTIMATOR() :
+        m_lengthCost( 0 ),
+        m_cornerCost( 0 )
+    {}
+
+    PNS_COST_ESTIMATOR( const PNS_COST_ESTIMATOR& aB ) :
+        m_lengthCost( aB.m_lengthCost ),
+        m_cornerCost( aB.m_cornerCost )
+    {}
+
+    ~PNS_COST_ESTIMATOR() {};
+
+    static int CornerCost( const SEG& aA, const SEG& aB );
+    static int CornerCost( const SHAPE_LINE_CHAIN& aLine );
+    static int CornerCost( const PNS_LINE& aLine );
+
+    void Add( PNS_LINE& aLine );
+    void Remove( PNS_LINE& aLine );
+    void Replace( PNS_LINE& aOldLine, PNS_LINE& aNewLine );
+
+    bool IsBetter( PNS_COST_ESTIMATOR& aOther, double aLengthTolerance,
+                   double aCornerTollerace ) const;
+
+    double GetLengthCost() const { return m_lengthCost; }
+    double GetCornerCost() const { return m_cornerCost; }
+
+private:
+    double m_lengthCost;
+    int m_cornerCost;
+};
+
+/**
+ * Class PNS_OPTIMIZER
+ *
+ * Performs various optimizations of the lines being routed, attempting to make the lines shorter
+ * and less cornery. There are 3 kinds of optimizations so far:
+ * - Merging obtuse segments (MERGE_OBTUSE): tries to join together as many
+ *   obtuse segments as possible without causing collisions
+ * - Rerouting path between pair of line corners with a 2-segment "\__" line and iteratively repeating
+ *   the procedure as long as the total cost of the line keeps decreasing
+ * - "Smart Pads" - that is, rerouting pad/via exits to make them look nice (SMART_PADS).
+ **/
+class PNS_OPTIMIZER
+{
+public:
+    enum OptimizationEffort
+    {
+        MERGE_SEGMENTS  = 0x01,
+        SMART_PADS      = 0x02,
+        MERGE_OBTUSE    = 0x04,
+        FANOUT_CLEANUP    = 0x08
+    };
+
+    PNS_OPTIMIZER( PNS_NODE* aWorld );
+    ~PNS_OPTIMIZER();
+
+    ///> a quick shortcut to optmize a line without creating and setting up an optimizer
+    static bool Optimize( PNS_LINE* aLine, int aEffortLevel, PNS_NODE* aWorld);
+
+    bool Optimize( PNS_LINE* aLine, PNS_LINE* aResult = NULL );
+    bool Optimize( PNS_DIFF_PAIR* aPair );
+
+
+    void SetWorld( PNS_NODE* aNode ) { m_world = aNode; }
+    void CacheStaticItem( PNS_ITEM* aItem );
+    void CacheRemove( PNS_ITEM* aItem );
+    void ClearCache( bool aStaticOnly = false );
+
+    void SetCollisionMask( int aMask )
+    {
+        m_collisionKindMask = aMask;
+    }
+
+    void SetEffortLevel( int aEffort )
+    {
+        m_effortLevel = aEffort;
+    }
+
+
+    void SetRestrictArea( const BOX2I& aArea )
+    {
+        m_restrictArea = aArea;
+        m_restrictAreaActive = true;
+    }
+
+private:
+    static const int MaxCachedItems = 256;
+
+    typedef std::vector<SHAPE_LINE_CHAIN> BREAKOUT_LIST;
+
+    struct CACHE_VISITOR;
+
+    struct CACHED_ITEM
+    {
+        int m_hits;
+        bool m_isStatic;
+    };
+
+    bool mergeObtuse( PNS_LINE* aLine );
+    bool mergeFull( PNS_LINE* aLine );
+    bool removeUglyCorners( PNS_LINE* aLine );
+    bool runSmartPads( PNS_LINE* aLine );
+    bool mergeStep( PNS_LINE* aLine, SHAPE_LINE_CHAIN& aCurrentLine, int step );
+    bool fanoutCleanup( PNS_LINE * aLine );
+    bool mergeDpSegments( PNS_DIFF_PAIR *aPair );
+    bool mergeDpStep( PNS_DIFF_PAIR *aPair, bool aTryP, int step );
+
+    bool checkColliding( PNS_ITEM* aItem, bool aUpdateCache = true );
+    bool checkColliding( PNS_LINE* aLine, const SHAPE_LINE_CHAIN& aOptPath );
+
+    void cacheAdd( PNS_ITEM* aItem, bool aIsStatic );
+    void removeCachedSegments( PNS_LINE* aLine, int aStartVertex = 0, int aEndVertex = -1 );
+
+    BREAKOUT_LIST circleBreakouts( int aWidth, const SHAPE* aShape, bool aPermitDiagonal ) const;
+    BREAKOUT_LIST rectBreakouts( int aWidth, const SHAPE* aShape, bool aPermitDiagonal ) const;
+    BREAKOUT_LIST ovalBreakouts( int aWidth, const SHAPE* aShape, bool aPermitDiagonal ) const;
+    BREAKOUT_LIST convexBreakouts( int aWidth, const SHAPE* aShape, bool aPermitDiagonal ) const;
+    BREAKOUT_LIST computeBreakouts( int aWidth, const PNS_ITEM* aItem, bool aPermitDiagonal ) const;
+
+    int smartPadsSingle( PNS_LINE* aLine, PNS_ITEM* aPad, bool aEnd, int aEndVertex );
+
+    PNS_ITEM* findPadOrVia( int aLayer, int aNet, const VECTOR2I& aP ) const;
+
+    SHAPE_INDEX_LIST<PNS_ITEM*> m_cache;
+
+    typedef boost::unordered_map<PNS_ITEM*, CACHED_ITEM> CachedItemTags;
+    CachedItemTags m_cacheTags;
+    PNS_NODE* m_world;
+    int m_collisionKindMask;
+    int m_effortLevel;
+    bool m_keepPostures;
+
+    BOX2I m_restrictArea;
+    bool m_restrictAreaActive;
+};
+
+#endif