search

BridgesUNCC / bridges-python

Python client library for Bridges
http://bridgesuncc.github.io
MIT License
3 stars 4 forks source link

Python Issues - to sync to C++ and Java #36

Closed krs-world closed 5 years ago

krs-world commented 5 years ago

Been going through the classes to improve the documentation and fix issues:

To do (so far):

  1. Need to implement Polyline Polygon (exists) is derived from Polyline
  2. Kd Tree -- need setters for children (check C++ or Java version)
  3. The shape collection classes (Symbol, Circle,Rectangle, etc) have been revamped, cleaned up and transformations added - this needs to be updated for python.
  4. A test face_shp_coll has been added in Java and C++ to test the transformations - neet to e ported to python and test the updates (of 3).
  5. Polygon class has no documentation at all (I would rather not do that and break something).. I am only touching editing existing comments for now.
  6. Line chart needs to be documented. I put the main description at the top.
  7. For the element visualizer, where are the shape names defined? (el.setShape(??)) this needs to be in the docs for element_visualizer and perhaps element, as it has calls from there as well.
  8. Array has been modified -- we now have Array1D, Array2D, Array3D in Java and C++ - needs to be done for python, makes use of Array much simpler.
  9. line_chart.py: get_data_structure_representation() seems to be empty? How can it work?

Am going to assign to both Matthew and Alec to help out and speed up the process.

krs-world commented 5 years ago

On the Edge type in python: the edge date is pointing to a string - but it should be generic - was this implemented to conform to Java and C++, where we have the template definition as

template<typename K, typename E1 = K, typename E2 = E1> class GraphAdjList : public DataStructure E1 referring to vertex and E2 referrring to edge data (which will be held in edges) ?