Skip to content

Latest commit

 

History

History
203 lines (133 loc) · 6.06 KB

CHANGELOG.md

File metadata and controls

203 lines (133 loc) · 6.06 KB
Raw

Changelog

2.0.0 (Jul. 19, 2021)

BREAKING CHANGES

  • Require Python 3.
  • Remove vg.orient() (replace with vg.aligned_with())
  • Remove vg.matrix.transform() (replace with polliwog.transform.apply_transform())
  • Remove vg.matrix.pad_with_ones() and vg.matrix.unpad() (no replacement offered)
  • Remove vg.__version__.

New features

  • Add v2 forward-compatibility layer. When updating libraries to use vg>=2.0, ensure you are not using any of the functions removed in v2, and update your imports to from vg.compat import v2 as vg. Applications can do the same or import vg. See Future-proofing your application or library for more explanation of the forward-compatibility layer.

2.0.0rc0 (Jul. 18, 2021)

See release notes for 2.0.0.

1.11.1 (Jul. 13, 2021)

  • Fix vg.compat.v1.shape.* and vg.compat.v1.matrix.*.

1.11.0 (Jul. 10, 2021)

  • Starting with this release, all libraries depending on vg are encouraged to use the new forward-compatibility layer. Replace import vg with from vg.compat import v1 as vg and use >=1.11 as your dependency specifier. You can also replace 1.11 with a later version which includes a feature you need. The important thing is not to use >=1.11,<2. Since this project guarantees that from vg.compat import v1 as vg will continue to work the same in 2.0+, the <2 constraint provides no stability value – and it makes things unnecessarily difficult for consumers who use multiple dependencies with vg.

    Applications have two options:

    1. Follow the recommendation for libraries: specify >=1.11 and import using from vg.compat import v1 as vg. This option provides better code stability and makes upgrades seamless.
    2. Specify >=1.11,<2 and use import vg directly, and when upgrading to >=2,<3, review the changelog and modify the calling code if necessary. This option ensures you stay up to date with the recommended, friendliest interface for calling into vg.

  • Rename vg.orient() to vg.aligned_with(). vg.orient() will be removed in vg 2.

  • Deprecate vg.matrix.pad_with_ones(), vg.matrix.unpad(), and vg.matrix.transform() (in favor of polliwog.transform.apply_transform()). These functions will be removed in vg 2. (See lace/polliwog#113 for additional context on why pad_with_ones() and unpad() are being removed.)

New features

  • Add vg.compat forward-compatibility layer for libraries.

Documentation

  • Clarify what goes in vg vs. what goes in polliwog.

1.10.0 (May 7, 2021)

  • Add vg.apex_and_opposite(), which is like vg.apex() except it returns both extreme points.

1.9.0 (Jun. 4, 2020)

  • Add vg.argapex(), which is like vg.apex() except it returns the index instead of the point.

1.8.0 (Apr. 22, 2020)

  • Add vg.shape.columnize(), a helper function for functions which may, accept and return a stack of points or a single point.
  • Add vg.shape.check_value_any() for checking an input against multiple valid shape.
  • Fix vg.euclidean_distance() so it will correctly accept a single point as the first argument with a stack of points as the second argument.
  • Correct many erroneous mentions of 3x1 and kx1 in the documentation and error messages.

1.7.0 (Jan. 22, 2020)

  • Add vg.average().
  • vg.apex(): Return a copy instead of a view.
  • Improve documentation intro.
  • Distribute universal wheels.

1.6.1 (Oct. 27, 2019)

  • Fix vg.nearest() and vg.farthest() with ret_index=False

1.6.0 (Oct. 27, 2019)

  • Allow vg.scale_factor() to accept a mix of stacked and unstacked inputs.

1.5.0 (Oct. 24, 2019)

  • Add vg.nearest().
  • Add vg.scale_factor().
  • Add vg.orient().
  • Improve documentation, including docs for vg.almost_collinear().

1.4.0 (Oct. 6, 2019)

  • vg.scalar_projection and vg.project: Allow stacked inputs for onto when vector is also stacked.

1.3.0 (Sep 30, 2019)

Same as 1.2.2 but republished to reflect correct semver.

1.2.2 (Sep 29, 2019)

  • Add vg.euclidean_distance.
  • Fix encoding error during installation on Windows 10.

1.2.1 (June 30, 2019)

  • Fix vg.shape.check for scalars.

1.2.0 (May 29, 2019)

  • Add vg.cross and vg.dot.
  • Allow vg.perpendicular to accept a mix of stacked and unstacked inputs.

1.1.0 (May 13, 2019)

  • Add vg.almost_unit_length
  • Add vg.within

1.0.0 (Apr 4, 2019)

  • BREAKING CHANGE: Rename vg.proj() -> vg.project().
  • BREAKING CHANGE: Rename vg.sproj() -> vg.scalar_projection().
  • BREAKING CHANGE: Move matrix functions into namespace.
  • BREAKING CHANGE: Give second argument to vg.apex() a better name
  • Add vg.almost_equal().
  • Improve documentation.

0.6.0 (Apr 3, 2019)

  • Add vg.shape.check() and vg.shape.check_value()

0.5.2 (Mar 28, 2019)

  • Again, fix concurrent install with numpy by avoiding numpy import during install.

0.5.1 (Mar 28, 2019)

  • Fix concurrent install with numpy by avoiding numpy import during install.

0.5.0 (Mar 28, 2019)

  • Add vg.apex() and vg.farthest()
  • Fix documentation typos.
  • Update dev dependencies.

0.4.0 (Jan 17, 2019)

  • Add vg.perpendicular() for computing the vector perpendicular to two others.
  • Add vg.rotate() for rotating a point or vector some number of degrees (or radians) around an axis.
  • Add "before and after" examples to the docs.
  • 100% code coverage.

0.3.0 (Nov 16, 2018)

  • Add principal-component-analysis functions principal_components() and major_axis().

0.2.0 (Oct 5, 2018)

  • Vectorize angle() and unsigned_angle() and improve documentation and test coverage.
  • Test the return type for magnitude() and improve documentation.
  • Present documentation on a single page.
  • Other doc improvements.

0.1.0 (Oct 2, 2018)

Initial release.