Merge pull request #8 from apache/LicenseSwap2
License swap2
diff --git a/.travis.yml b/.travis.yml
index 5fac442..58b7004 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,3 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
# http://docs.travis-ci.com/user/customizing-the-build/
language: java
@@ -5,7 +20,7 @@
sudo: false # faster builds
jdk:
- - oraclejdk8
+ - openjdk8
install:
- mvn install -Dmaven.javadoc.skip=true -Dsource.skip=true -DskipTests=true -Dgpg.skip=true
diff --git a/DISCLAIMER-WIP b/DISCLAIMER-WIP
new file mode 100644
index 0000000..c90f3f7
--- /dev/null
+++ b/DISCLAIMER-WIP
@@ -0,0 +1,26 @@
+Apache DataSketches (incubating) is an effort undergoing incubation
+at The Apache Software Foundation (ASF), sponsored by the Apache Incubator.
+
+Incubation is required of all newly accepted projects until a further review
+indicates that the infrastructure, communications, and decision making process
+have stabilized in a manner consistent with other successful ASF projects.
+
+While incubation status is not necessarily a reflection of the
+completeness or stability of the code, it does indicate that the
+project has yet to be fully endorsed by the ASF.
+
+Some of the incubating project's releases may not be fully compliant
+with ASF policy. For example, releases may have incomplete or
+un-reviewed licensing conditions. What follows is a list of known
+issues the project is currently aware of (note that this list, by
+definition, is likely to be incomplete):
+
+ * The LICENSE and NOTICE files may not be complete and will be fixed with the next release.
+
+If you are planning to incorporate this work into your
+product or project, please be aware that you will need to conduct a
+thorough licensing review to determine the overall implications of
+including this work. For the current status of this project through the Apache
+Incubator visit:
+
+http://incubator.apache.org/projects/datasketches.html
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f927b76
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,210 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+
+
+APPENDIX A: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+ -------------------------------------------------------------
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -------------------------------------------------------------
+
+
+
+APPENDIX B: Additional licenses relevant to this product:
+ (none)
diff --git a/LICENSE.md b/LICENSE.md
deleted file mode 100644
index 4d2d52c..0000000
--- a/LICENSE.md
+++ /dev/null
@@ -1,54 +0,0 @@
-Apache License
-
-Version 2.0, January 2004
-
-https://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
-
-"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
-
-"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-
-"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
-
-"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
-
-"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
-
-"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
-
-"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
-
-"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
-
-"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
-
- You must give any other recipients of the Work or Derivative Works a copy of this License; and
- You must cause any modified files to carry prominent notices stating that You changed the files; and
- You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
- If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
-
- You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
\ No newline at end of file
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..b5eb326
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,11 @@
+Apache DataSketches Vector (incubating)
+Copyright 2019 - The Apache Software Foundation
+
+Copyright 2015-2018 Yahoo
+Copyright 2018 - Verizon Media
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+Prior to moving to ASF, the software for this project was developed at
+Yahoo (now Verizon Media) (https://developer.yahoo.com).
diff --git a/README.md b/README.md
index 581c3f5..f68dedb 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,90 @@
-[![][travis img]][travis]
<!--
-[![][mavenbadge img]][mavenbadge] [](https://codecov.io/gh/DataSketches/sketches-vector)
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
-[![][gitter img]][gitter]
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
-->
+
+[](https://travis-ci.org/apache/incubator-datasketches-vector)
+
+<!--
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-vector)
+[](https://lgtm.com/projects/g/apache/incubator-datasketches-vector/context:java)
+[](https://lgtm.com/projects/g/apache/incubator-datasketches-vector/alerts/)
+[](https://coveralls.io/github/apache/incubator-datasketches-vector?branch=master)
+-->
+
=================
-# Sketches Vector Library
-
-## [Documentation](https://datasketches.github.io)
-
-<!--## [Latest Release](https://github.com/DataSketches/sketches-vector/releases)-->
-
-## [Comments](https://groups.google.com/forum/#!forum/sketches-user)
-
-## [Building](https://github.com/DataSketches/sketches-vector/blob/master/README_building.md)
+# DataSketches Vector Library (Experimental)
+This code is offered "as is" and may not be to the quality of code in, for example, the core datasketches-java repository.
-[travis]:https://travis-ci.org//DataSketches/sketches-vector/builds?branch=master
-[travis img]:https://secure.travis-ci.org/DataSketches/sketches-vector.svg?branch=master
+## Documentation
-[mavenbadge]:https://search.maven.org/#search|gav|1|g%3A%22com.yahoo.datasketches%22%20AND%20a%3A%22sketches-vector%22
-[mavenbadge img]:https://maven-badges.herokuapp.com/maven-central/com.yahoo.datasketches/sketches-vector/badge.svg
+### [DataSketches Library Website](https://datasketches.github.io/)
-[gitter]:https://gitter.im/DataSketches/sketches-vector
-[gitter img]:https://img.shields.io/badge/gitter-JOIN%20CHAT-blue.svg
+### [Comments](https://groups.google.com/forum/#!forum/sketches-user)
+
+### [Building](https://github.com/DataSketches/sketches-vector/blob/master/README_building.md)
+
+## Build Instructions
+
+### JDK8 is Required Compiler
+This DataSketches component is pure Java and you must compile using JDK 8.
+
+### Recommended Build Tool
+The DataSketches-java component structured as a Maven project and Maven is the recommended Build Tool.
+
+There are two types of tests: normal unit tests and tests run by the strict profile.
+
+To run normal unit tests:
+
+ $ mvn clean test
+
+To run the strict profile tests:
+
+ $ mvn clean test -P strict
+
+To install jars built from the downloaded source:
+
+ $ mvn clean install -DskipTests=true
+
+This will create the following jars:
+
+* datasketches-vector-X.Y.Z-incubating.jar The compiled main class files.
+* datasketches-vector-X.Y.Z-incubating-tests.jar The compiled test class files.
+* datasketches-vector-X.Y.Z-incubating-sources.jar The main source files.
+* datasketches-vector-X.Y.Z-incubating-test-sources.jar The test source files
+* datasketches-vector-X.Y.Z-incubating-javadoc.jar The compressed Javadocs.
+
+### Dependencies
+
+#### Run-time
+There are two run-time dependencies:
+
+* org.ojalgo : ojalgo
+* org.apache.datasketches : datasketches-memory
+
+#### Testing
+See the pom.xml file for test dependencies.
+
+## Resources
+
+### [Issues for datasketches-java](https://github.com/apache/incubator-datasketches-java/issues)
+
+### [Forum](https://groups.google.com/forum/#!forum/sketches-user)
+
+### [Dev mailing list](dev@datasketches.apache.org)
diff --git a/README_building.md b/README_building.md
deleted file mode 100644
index dee7a6c..0000000
--- a/README_building.md
+++ /dev/null
@@ -1,74 +0,0 @@
-
-
-## Building sketches-core
-Use Apache Maven 3.0 to build this project
-
-### Requires JDK8
-DataSketches sketches-vector leverages new API methods introduced with JDK8.
-JDK7 is no longer supported.
-
-
-### Basic Build
- mvn clean install
-
-### Build including source and javadoc jars
- mvn -P release-profile clean install
-
-#### Mac install
-To install you will need GnuPG which is not configured by default on Macs.
-
- brew install gnupg
- gpg --gen-key
-
-Then, follow instructions to create keys.
-
-To install Homebrew
-
- ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-
-### Release build, incrementing the version number and publishing to maven central repository
-
-#### Prepare a release
-First, "prepare" a release. Preparing a release ensures you have no checked out file and no SNAPSHOT dependencies.
-It changes the version in all pom.xml files to the release version. It then runs all the tests. If everything passes,
-the release version is committed to the SCM system and tagged. The version number is then updated in all the pom.xml
-files again, this time to the next development version. Finally, the changes are committed again to the SCM repository.
-
- mvn release:prepare
-
-1. ensure you have **no** uncommitted files in your workspace. Ideally, use a fresh workspace for the release process.
-2. Answer the prompts with appropriate values for the tag, version, and new development version
- - release version should be something like 1.0.1
- - development version should be something like 1.0.2-SNAPSHOT
- - tag should be something like sketches-vector-1.0.1
-3. If the prepare has an error (the build will fail if any tests fail), run 'mvn release:clean' to clean up the
-generated files and reset the workspace. If the prepare needs to be rolled back (undone in the SCM system), run 'mvn release:rollback'.
-
-See https://maven.apache.org/maven-release/maven-release-plugin/examples/prepare-release.html for more info.
-
-#### Perform a release:
-Next, "perform" a release. Performing a release checks out the tagged release from the SCM system into a new directory,
-builds it, and then runs the configured deploy goals to publish the release to a maven repository (Maven central). Performing
-a release automatically enables the `release-profile` in maven, causing source and javadoc jars to be automatically created
-and published.
-
- mvn release:perform
-
-You can add the '-DdryRun=true' option to test the release process without actually generating a release. dryRun is
-supported on both the prepare and perform steps.
-
-See https://maven.apache.org/maven-release/maven-release-plugin/examples/perform-release.html for more info.
-
-#### Rollback a release
-If a release has been prepared but not performed yet, the release can be rolled back. Rolling back a release resets
-the pom.xml version numbers and tags in the SCM system, effectively nullifying the release.
-
- mvn release:rollback
-
-A release cannot be rolled back if it has already been cleaned up (the release.properties file and other metadata removed).
-
-#### Clean a release
-If a release fails to prepare or crashs, it can leave various files behind. These can be cleaned up with a release clean.
-
- mvn release:clean
-
diff --git a/pom.xml b/pom.xml
index 4d552fa..bbf59bd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,413 +1,626 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- Copyright 2017, Yahoo! Inc.
- Licensed under the terms of the Apache License 2.0.
- See LICENSE file at the project root for terms. -->
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
+ http://www.apache.org/licenses/LICENSE-2.0
- <groupId>org.apache.datasketches</groupId>
- <artifactId>datasketches-vector</artifactId>
- <version>0.0.3-SNAPSHOT</version>
- <packaging>jar</packaging>
-
- <!-- Project Information -->
- <name>${project.groupId}:${project.artifactId}</name>
- <description>Sketches with vector-based inputs.</description>
- <url>https://datasketches.github.io/</url>
- <inceptionYear>2017</inceptionYear>
-
- <licenses>
- <license>
- <name>Apache License, Version 2.0</name>
- <url>https://www.apache.org/licenses/LICENSE-2.0</url>
- </license>
- </licenses>
-
- <organization>
- <name>Yahoo! Inc.</name>
- <url>https://www.yahoo.com</url>
- </organization>
-
- <developers>
- <developer>
- <name>Jon Malkin</name>
- <roles>
- <role>lead developer</role>
- </roles>
- <url>https://github.com/jmalkin</url>
- </developer>
- </developers>
-
- <contributors>
- <contributor>
- <url>https://github.com/DataSketches/sketches-vector/graphs/contributors</url>
- </contributor>
- </contributors>
- <!-- End Project Information -->
-
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <project.build.resourceEncoding>UTF-8</project.build.resourceEncoding>
- <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
- <maven.compiler.source>1.8</maven.compiler.source>
- <maven.compiler.target>1.8</maven.compiler.target>
- <argLine>-Xmx1024m -Duser.language=en -Duser.country=US -Dfile.encoding=UTF-8</argLine>
- </properties>
-
- <!-- Environment Settings -->
- <issueManagement>
- <system>GitHub Issues</system>
- <url>https://github.com/DataSketches/sketches-vector/issues</url>
- </issueManagement>
-
- <ciManagement>
- <system>travis</system>
- <url>https://travis-ci.org/DataSketches/sketches-vector</url>
- </ciManagement>
-
- <mailingLists>
- <mailingList>
- <name>sketches-user</name>
- <archive>https://groups.google.com/forum/#!forum/sketches-user</archive>
- <subscribe>mailto:sketches-user%2Bsubscribe@googlegroups.com</subscribe>
- <unsubscribe>mailto:sketches-user%2Bunsubscribe@googlegroups.com</unsubscribe>
- <post>mailto:sketches-user@googlegroups.com</post>
- </mailingList>
- </mailingLists>
-
- <scm>
- <connection>scm:git:ssh://git@github.com/DataSketches/sketches-vector.git</connection>
- <developerConnection>scm:git:ssh://git@github.com/DataSketches/sketches-vector.git</developerConnection>
- <url>https://github.com/DataSketches/sketches-vector</url>
- <tag>HEAD</tag>
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>apache</artifactId>
+ <version>21</version>
+ </parent>
+ <groupId>org.apache.datasketches</groupId>
+
+ <!-- UNIQUE FOR THIS JAVA COMPONENT -->
+ <artifactId>datasketches-vector</artifactId>
+ <version>1.0.0-incubating-SNAPSHOT</version>
+ <description>Vector sketch algorithms for the DataSketches library.</description>
+ <!-- END: UNIQUE FOR THIS JAVA COMPONENT -->
+
+ <url>https://datasketches.apache.org/</url>
+ <name>${project.artifactId}</name>
+ <inceptionYear>2015</inceptionYear>
+ <packaging>jar</packaging>
+ <!-- jar is the default -->
+ <!-- With the 3.6.1 version of Maven this causes a warning to obsolete this in
+ favor of using the enforcer plugin (which we do). But removing this
+ causes the command "mvn versions:display-plugin-updates" to issue an error
+ and not work properly. So this will stay for the time being.
+ -->
+ <prerequisites>
+ <maven>3.2.0</maven>
+ </prerequisites>
+ <licenses>
+ <license>
+ <name>Apache License, Version 2.0</name>
+ <url>https://www.apache.org/licenses/LICENSE-2.0</url>
+ <distribution>repo</distribution>
+ </license>
+ </licenses>
+ <scm>
+ <connection>scm:git:ssh://git@github.com/apache/incubator-${project.artifactId}.git</connection>
+ <developerConnection>scm:git:ssh://git@github.com/apache/incubator-${project.artifactId}.git</developerConnection>
+ <url>https://github.com/apache/incubator-${project.artifactId}</url>
+ <tag>HEAD</tag>
</scm>
-
- <prerequisites>
- <maven>3.0.4</maven>
- </prerequisites>
-
- <repositories>
- <repository>
- <id>jcenter</id>
- <name>bintray</name>
- <url>https://jcenter.bintray.com</url>
- </repository>
- <repository>
- <id>sonatype-releases</id>
- <url>https://oss.sonatype.org/content/repositories/releases/</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
- </repositories>
-
- <distributionManagement>
- <repository>
- <id>sonatype-nexus-staging</id>
- <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
- </repository>
- </distributionManagement>
-
- <!-- This is optional -->
- <profiles>
- <profile>
- <id>strict</id>
- <build>
- <pluginManagement>
- <plugins>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-compiler-plugin</artifactId>
- <configuration>
- <source>${maven.compiler.source}</source>
- <target>${maven.compiler.target}</target>
- <compilerId>javac-with-errorprone</compilerId>
- <forceJavacCompilerUse>true</forceJavacCompilerUse>
- </configuration>
- <dependencies>
- <dependency>
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-compiler-javac-errorprone</artifactId>
- <version>2.8.2</version>
- </dependency>
- </dependencies>
- </plugin>
-
- </plugins>
- </pluginManagement>
- </build>
- </profile>
- </profiles>
- <!-- End of Environment Settings -->
-
- <dependencies>
- <dependency>
- <groupId>org.ojalgo</groupId>
- <artifactId>ojalgo</artifactId>
- <version>47.0.0</version>
- </dependency>
-
- <dependency>
- <groupId>com.yahoo.datasketches</groupId>
- <artifactId>memory</artifactId>
- <version>0.10.2</version>
- </dependency>
-
- <!-- Test Scope -->
- <dependency>
- <groupId>org.testng</groupId>
- <artifactId>testng</artifactId>
- <version>6.11</version>
- <scope>test</scope>
- </dependency>
-
- <!-- run locally for now
- <dependency>
- <groupId>com.google.code.findbugs</groupId>
- <artifactId>findbugs</artifactId>
- <version>3.0.1</version>
- <scope>test</scope>
- </dependency>
- -->
- </dependencies>
-
- <build>
- <plugins>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-shade-plugin</artifactId>
- <executions>
- <execution>
- <phase>package</phase>
- <goals>
- <goal>shade</goal>
- </goals>
- <configuration>
- <relocations>
- <relocation>
- <pattern>com.yahoo.memory</pattern>
- <shadedPattern>shaded.com.yahoo.memory</shadedPattern>
- </relocation>
- </relocations>
- <shadedArtifactAttached>true</shadedArtifactAttached>
- <shadedClassifierName>with-shaded-memory</shadedClassifierName>
- </configuration>
- </execution>
- </executions>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <!--
- <show>private</show>
- -->
- <stylesheetfile>src/main/javadoc/stylesheet.css</stylesheetfile>
- <docfilessubdirs>true</docfilessubdirs>
- </configuration>
- <executions>
- <execution>
- <id>attach-javadocs</id>
- <goals>
- <goal>jar</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-source-plugin</artifactId>
- <executions>
- <execution>
- <id>attach-sources</id>
- <goals>
- <goal>jar-no-fork</goal>
- <goal>test-jar-no-fork</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
-
- <plugin>
- <groupId>org.sonatype.plugins</groupId>
- <artifactId>nexus-staging-maven-plugin</artifactId>
- <extensions>true</extensions>
- <configuration>
- <serverId>sonatype-nexus-staging</serverId>
- <nexusUrl>https://oss.sonatype.org/</nexusUrl>
- <autoReleaseAfterClose>false</autoReleaseAfterClose>
- </configuration>
- </plugin>
-
- <!-- Code coverage plugin, generates coverage report to target/site/jacoco/
- To skip coverage generation add -Djacoco.skip=true -->
- <plugin>
- <groupId>org.jacoco</groupId>
- <artifactId>jacoco-maven-plugin</artifactId>
- <executions>
- <execution>
- <goals>
- <goal>prepare-agent</goal>
- </goals>
- </execution>
- <execution>
- <id>report</id>
- <phase>test</phase>
- <goals>
- <goal>report</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-gpg-plugin</artifactId>
- <executions>
- <execution>
- <id>sign-artifacts</id>
- <phase>verify</phase>
- <goals>
- <goal>sign</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
-
- </plugins>
-
+ <issueManagement>
+ <!-- <system>jira</system>
+ <url>https://issues.apache.org/jira/browse/DATASKETCHES</url> -->
+ <system>GitHub</system>
+ <url>https://github.com/apache/incubator-${project.artifactId}/issues</url>
+ </issueManagement>
+ <mailingLists>
+ <mailingList>
+ <name>DataSketches Developers</name>
+ <subscribe>dev-subscribe@datasketches.apache.org</subscribe>
+ <unsubscribe>dev-unsubscribe@datasketches.apache.org</unsubscribe>
+ <post>dev@datasketches.apache.org</post>
+ <archive>https://mail-archives.apache.org/mod_mbox/datasketches-dev</archive>
+ </mailingList>
+ <mailingList>
+ <name>sketches-user</name>
+ <archive>https://groups.google.com/forum/#!forum/sketches-user</archive>
+ <subscribe>mailto:sketches-user%2Bsubscribe@googlegroups.com</subscribe>
+ <unsubscribe>mailto:sketches-user%2Bunsubscribe@googlegroups.com</unsubscribe>
+ <post>mailto:sketches-user@googlegroups.com</post>
+ </mailingList>
+ </mailingLists>
+ <developers>
+ <developer>
+ <name>The Apache DataSketches Team</name>
+ <email>dev@datasketches.apache.org</email>
+ <url>https://datasketches.apache.org</url>
+ <organization>Apache Software Foundation</organization>
+ <organizationUrl>http://www.apache.org</organizationUrl>
+ </developer>
+ </developers>
+ <properties>
+
+ <!-- UNIQUE FOR THIS JAVA COMPONENT -->
+ <ojalgo.version>47.0.0</ojalgo.version>
+ <datasketches-memory.version>1.1.0-incubating</datasketches-memory.version>
+ <!-- END:UNIQUE FOR THIS JAVA COMPONENT -->
+
+ <!-- Test -->
+ <testng.version>6.14.3</testng.version>
+ <!-- System-wide properties -->
+ <argLine>-Xmx4g -Duser.language=en -Duser.country=US -Dfile.encoding=UTF-8</argLine>
+ <charset.encoding>UTF-8</charset.encoding>
+ <project.build.sourceEncoding>${charset.encoding}</project.build.sourceEncoding>
+ <project.build.resourceEncoding>${charset.encoding}</project.build.resourceEncoding>
+ <project.reporting.outputEncoding>${charset.encoding}</project.reporting.outputEncoding>
+ <java.version>1.8</java.version>
+ <maven.compiler.source>${java.version}</maven.compiler.source>
+ <maven.compiler.target>${java.version}</maven.compiler.target>
+ <!-- org.codehaus.plexus used for strict profile testing-->
+ <plexus-compiler-javac-errorprone.version>2.8.5</plexus-compiler-javac-errorprone.version>
+ <!-- Maven Plugins -->
+ <maven-assembly-plugin.version>3.1.1</maven-assembly-plugin.version>
+ <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
+ <maven-deploy-plugin.version>3.0.0-M1</maven-deploy-plugin.version>
+ <maven-enforcer-plugin.version>3.0.0-M2</maven-enforcer-plugin.version>
+ <maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
+ <maven-jar-plugin.version>3.1.2</maven-jar-plugin.version>
+ <maven-javadoc-plugin.version>3.1.1</maven-javadoc-plugin.version>
+ <maven-release-plugin.version>2.5.3</maven-release-plugin.version>
+ <maven-remote-resources-plugin.version>[1.0,)</maven-remote-resources-plugin.version>
+ <maven-source-plugin.version>3.1.0</maven-source-plugin.version>
+ <maven-surefire-plugin.version>3.0.0-M3</maven-surefire-plugin.version>
+ <!-- Apache Plugins -->
+ <apache-rat-plugin.version>0.13</apache-rat-plugin.version>
+ <!-- org.jacoco Maven Plugins -->
+ <jacoco-maven-plugin.version>0.8.4</jacoco-maven-plugin.version>
+ <!-- org.eluder Maven Plugins -->
+ <coveralls-maven-plugin.version>4.3.0</coveralls-maven-plugin.version>
+ <!-- other -->
+ <lifecycle-mapping.version>1.0.0</lifecycle-mapping.version>
+ <git-commit-id-plugin.version>3.0.0</git-commit-id-plugin.version>
+ </properties>
+ <repositories>
+ <repository>
+ <id>apache.snapshots</id>
+ <name>Apache Snapshot Repository</name>
+ <url>https://repository.apache.org/content/groups/snapshots/org/apache/datasketches/</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ <repository>
+ <id>apache</id>
+ <name>Apache Releases Repository</name>
+ <url>https://repository.apache.org/content/repositories/releases/org/apache/datasketches/</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>false</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ <dependencies>
+
+ <!-- UNIQUE FOR THIS JAVA COMPONENT -->
+ <dependency>
+ <groupId>org.ojalgo</groupId>
+ <artifactId>ojalgo</artifactId>
+ <version>${ojalgo.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.datasketches</groupId>
+ <artifactId>datasketches-memory</artifactId>
+ <version>${datasketches-memory.version}</version>
+ </dependency>
+ <!-- END: UNIQUE FOR THIS JAVA COMPONENT -->
+
+ <!-- Test Scope -->
+ <dependency>
+ <groupId>org.testng</groupId>
+ <artifactId>testng</artifactId>
+ <version>${testng.version}</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <!-- We want to deploy the artifacts to a staging location for perusal -->
+ <!-- Apache Parent pom: apache-release profile -->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-deploy-plugin</artifactId>
+ <version>${maven-deploy-plugin.version}</version>
+ <configuration>
+ <updateReleaseInfo>true</updateReleaseInfo>
+ <!-- see maven-install-plugin -->
+ </configuration>
+ </plugin>
+ <plugin>
+ <!-- Apache Parent pom, pluginManagement-->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-release-plugin</artifactId>
+ <version>${maven-release-plugin.version}</version>
+ </plugin>
+ <plugin>
+ <!-- Extends Apache Parent pom, pluginManagement-->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>${maven-jar-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>default-jar</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>default-test-jar</id>
+ <goals>
+ <goal>test-jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <!-- Extends Apache Parent pom, apache-release profile -->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${maven-javadoc-plugin.version}</version>
+ <configuration>
+ <docfilessubdirs>true</docfilessubdirs>
+ </configuration>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ <version>${maven-enforcer-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>enforce-banned-dependencies</id>
+ <goals>
+ <goal>enforce</goal>
+ </goals>
+ <configuration>
+ <rules>
+ <requireJavaVersion>
+ <version>1.8.0</version>
+ </requireJavaVersion>
+ <requireMavenVersion>
+ <version>3.2,</version>
+ </requireMavenVersion>
+ <bannedDependencies>
+ <excludes>
+ <!--LGPL licenced library-->
+ <exclude>com.google.code.findbugs:annotations</exclude>
+ </excludes>
+ </bannedDependencies>
+ </rules>
+ <fail>true</fail>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <!-- Apache Parent pom, pluginManagement-->
+ <groupId>org.apache.rat</groupId>
+ <artifactId>apache-rat-plugin</artifactId>
+ <version>${apache-rat-plugin.version}</version>
+ <executions>
+ <execution>
+ <phase>verify</phase>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <outputDirectory>${project.basedir}/rat</outputDirectory>
+ <consoleOutput>true</consoleOutput>
+ <useDefaultExcludes>true</useDefaultExcludes>
+ <excludes>
+ <!-- rat uses .gitignore for excludes by default -->
+ <exclude>**/test/resources/**/*.txt</exclude>
+ <exclude>LICENSE</exclude>
+ <exclude>NOTICE</exclude>
+ <exclude>DISCLAIMER-WIP</exclude>
+ </excludes>
+ </configuration>
+ </plugin>
+ <plugin>
+ <!-- Extends Apache Parent pom, apache-release profile -->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ <version>${maven-source-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>attach-sources</id>
+ <phase>package</phase>
+ <goals>
+ <goal>jar-no-fork</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>attach-test-sources</id>
+ <phase>package</phase>
+ <goals>
+ <goal>test-jar-no-fork</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <!-- Apache Parent pom, pluginManagement-->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <version>${maven-surefire-plugin.version}</version>
+ <configuration>
+ <trimStackTrace>false</trimStackTrace>
+ <useManifestOnlyJar>false</useManifestOnlyJar>
+ <redirectTestOutputToFile>true</redirectTestOutputToFile>
+ </configuration>
+ </plugin>
+ <plugin>
+ <!-- Generates code coverage report from website. -->
+ <groupId>org.jacoco</groupId>
+ <artifactId>jacoco-maven-plugin</artifactId>
+ <version>${jacoco-maven-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>prepare-agent</id>
+ <goals>
+ <goal>prepare-agent</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <!-- Submit code coverage report to Coveralls.io. -->
+ <groupId>org.eluder.coveralls</groupId>
+ <artifactId>coveralls-maven-plugin</artifactId>
+ <version>${coveralls-maven-plugin.version}</version>
+ <configuration>
+ <!-- Since we use Travis CI we do not have to put a Coveralls token here. -->
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-deploy-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-release-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.rat</groupId>
+ <artifactId>apache-rat-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.jacoco</groupId>
+ <artifactId>jacoco-maven-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.eluder.coveralls</groupId>
+ <artifactId>coveralls-maven-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </build>
+ <profiles>
+ <!-- Ignore nuisance warning from Apache parent plugin:
+ "maven-remote-resources-plugin (goal "process") is ignored by m2e".
+ This also should fix the Maven warning that it can't find the lifecycle-mapping jar.
+ This profile is only active when the property "m2e.version" is set,
+ which is the case when building in Eclipse with m2e.
+ The ignore below tells m2eclipse to skip the execution.
+ -->
+ <profile>
+ <id>m2e</id>
+ <activation>
+ <property>
+ <name>m2e.version</name>
+ </property>
+ </activation>
+ <build>
<pluginManagement>
- <plugins>
- <!-- ORG.APACHE.MAVEN -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-assembly-plugin</artifactId>
- <version>3.0.0</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-clean-plugin</artifactId>
- <version>3.0.0</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-compiler-plugin</artifactId>
- <version>3.6.1</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-dependency-plugin</artifactId>
- <version>3.0.1</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-deploy-plugin</artifactId>
- <version>2.8.2</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-gpg-plugin</artifactId>
- <version>1.6</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-help-plugin</artifactId>
- <version>2.2</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-install-plugin</artifactId>
- <version>2.5.2</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.4</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-release-plugin</artifactId>
- <version>2.5.3</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <version>3.0.2</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-shade-plugin</artifactId>
- <version>3.0.0</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-source-plugin</artifactId>
- <version>3.0.1</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <version>2.20</version>
- </plugin>
-
- <!-- OTHER -->
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>exec-maven-plugin</artifactId>
- <version>1.6.0</version>
- </plugin>
-
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>license-maven-plugin</artifactId>
- <version>1.13</version>
- </plugin>
-
- <plugin>
- <groupId>org.jacoco</groupId>
- <artifactId>jacoco-maven-plugin</artifactId>
- <version>0.7.9</version>
- </plugin>
-
- <plugin>
- <groupId>org.sonatype.plugins</groupId>
- <artifactId>nexus-staging-maven-plugin</artifactId>
- <version>1.6.8</version>
- </plugin>
-
- <plugin>
- <groupId>com.versioneye</groupId>
- <artifactId>versioneye-maven-plugin</artifactId>
- <version>3.11.4</version>
- </plugin>
-
- </plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.eclipse.m2e</groupId>
+ <artifactId>lifecycle-mapping</artifactId>
+ <version>${lifecycle-mapping.version}</version>
+ <configuration>
+ <lifecycleMappingMetadata>
+ <pluginExecutions>
+ <pluginExecution>
+ <pluginExecutionFilter>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-remote-resources-plugin</artifactId>
+ <versionRange>${maven-remote-resources-plugin.version}</versionRange>
+ <goals>
+ <goal>process</goal>
+ </goals>
+ </pluginExecutionFilter>
+ <action>
+ <ignore/>
+ </action>
+ </pluginExecution>
+ </pluginExecutions>
+ </lifecycleMappingMetadata>
+ </configuration>
+ </plugin>
+ </plugins>
</pluginManagement>
- </build>
+ </build>
+ </profile>
+ <profile>
+ <id>strict</id>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>${maven-compiler-plugin.version}</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-compiler-javac-errorprone</artifactId>
+ <version>${plexus-compiler-javac-errorprone.version}</version>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <source>${maven.compiler.source}</source>
+ <target>${maven.compiler.target}</target>
+ <compilerId>javac-with-errorprone</compilerId>
+ <forceJavacCompilerUse>true</forceJavacCompilerUse>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
+ </profile>
+ <!-- This profile is used to release signed jars to the Apache Nexus repository.
+ This must be executed from a git repository set at the proper Release branch (e.g., 1.1.X-incubating)
+ and at a Release Candidate tag (e.g., 1.1.0-incubating-RC1).
+ The pom version in the release branch must be properly set to something like: "1.1.0-incubating".
+ The pom version in the master would be set to something like: "1.2.0-incubating-SNAPSHOT".
+ Test Command: mvn clean verify -Pnexus-jars -DskipTests=true
+ Command: mvn clean deploy -Dnexus-jars
+ Verify Command (from terminal): gpg -v --verify $ASC $FILE # dashdashverify
+ -->
+ <profile>
+ <id>nexus-jars</id>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>pl.project13.maven</groupId>
+ <artifactId>git-commit-id-plugin</artifactId>
+ <version>${git-commit-id-plugin.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>revision</goal>
+ </goals>
+ <phase>initialize</phase>
+ </execution>
+ </executions>
+ <configuration>
+ <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
+ <dateFormatTimeZone>UTC</dateFormatTimeZone>
+ <verbose>false</verbose>
+ <skipPoms>false</skipPoms>
+ <format>json</format>
+ <generateGitPropertiesFile>true</generateGitPropertiesFile>
+ <generateGitPropertiesFilename>${project.build.directory}/git.properties</generateGitPropertiesFilename>
+ <failOnNoGitDirectory>true</failOnNoGitDirectory>
+ <failOnUnableToExtractRepoInfo>true</failOnUnableToExtractRepoInfo>
+ <commitIdGenerationMode>full</commitIdGenerationMode>
+ <includeOnlyProperties>
+ <includeProperty>git.branch</includeProperty>
+ <includeProperty>git.commit.id.full</includeProperty>
+ <includeProperty>git.commit.time</includeProperty>
+ <includeProperty>git.commit.user.email</includeProperty>
+ <includeProperty>git.tags</includeProperty>
+ </includeOnlyProperties>
+ <gitDescribe>
+ <skip>false</skip>
+ <always>true</always>
+ <abbrev>7</abbrev>
+ <dirty>-dirty</dirty>
+ <tags>true</tags>
+ <forceLongFormat>true</forceLongFormat>
+ </gitDescribe>
+ </configuration>
+ </plugin>
+ <!-- Extends Apache Parent pom, pluginManagement-->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>${maven-jar-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>default-jar</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>default-test-jar</id>
+ <goals>
+ <goal>test-jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <injectAllReactorProjects>true</injectAllReactorProjects>
+ <archive>
+ <manifest>
+ <addDefaultEntries>false</addDefaultEntries>
+ <addDefaultSpecificationEntries>false</addDefaultSpecificationEntries>
+ <addDefaultImplementationEntries>false</addDefaultImplementationEntries>
+ </manifest>
+ <manifestEntries>
+ <Build-Jdk>${java.version} (${java.vendor} ${java.vm.version})</Build-Jdk>
+ <Build-OS>${os.name} ${os.arch} ${os.version}</Build-OS>
+ <Implementation-Vendor>The Apache Software Foundation</Implementation-Vendor>
+ <GroupId-ArtifactId>${project.groupId}:${project.artifactId}</GroupId-ArtifactId>
+ <git-branch>${git.branch}</git-branch>
+ <git-commit-id>${git.commit.id.full}</git-commit-id>
+ <git-commit-time>${git.commit.time}</git-commit-time>
+ <git-commit-user-email>${git.commit.user.email}</git-commit-user-email>
+ <git-commit-tag>${git.tags}</git-commit-tag>
+ </manifestEntries>
+ </archive>
+ </configuration>
+ </plugin>
+ <!-- We want to sign the artifacts, POM, and all attached artifacts -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-gpg-plugin</artifactId>
+ <version>${maven-gpg-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>sign-artifacts</id>
+ <phase>verify</phase>
+ <goals>
+ <goal>sign</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <gpgArguments>
+ <arg>--verbose</arg>
+ <!-- prints the algorithm used -->
+ <arg>--personal-digest-preferences=SHA512</arg>
+ </gpgArguments>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>pl.project13.maven</groupId>
+ <artifactId>git-commit-id-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-gpg-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ <!-- Disable source release assembly for 'apache-release' profile.
+ This is performed from a script outside Maven
+ -->
+ <profile>
+ <id>apache-release</id>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <version>${maven-assembly-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>source-release-assembly</id>
+ <phase>none</phase>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
</project>
diff --git a/src/main/java/com/yahoo/sketches/vector/decomposition/SVDAlgo.java b/src/main/java/com/yahoo/sketches/vector/decomposition/SVDAlgo.java
deleted file mode 100644
index 36b5462..0000000
--- a/src/main/java/com/yahoo/sketches/vector/decomposition/SVDAlgo.java
+++ /dev/null
@@ -1,33 +0,0 @@
-package com.yahoo.sketches.vector.decomposition;
-
-/**
- * This class allows a choice of algorithms for Singular Value Decomposition. The options are:
- * <ul>
- * <li>FULL: The matrix library's default SVD implementation.</li>
- * <li>SISVD: Simultaneous iteration, an approximate method likely to be more efficient only with sparse
- * matrices or when <em>k</em> is significantly smaller than the number of rows in the sketch.</li>
- * <li>SYM: Takes advantage of matrix dimensionality, first computing eigenvalues of AA^T, then computes
- * intended results. Squaring A alters condition number and may cause numeric stability issues,
- * but unlikely an issue for Frequent Directions since discarding the smaller singular values/vectors.</li>
- * </ul>
- */
-public enum SVDAlgo {
- FULL(1, "Full"),
- SISVD(2, "SISVD"),
- SYM(3, "Symmetrized");
-
- private int id_;
- private String name_;
-
- SVDAlgo(final int id, final String name) {
- id_ = id;
- name_ = name;
- }
-
- public int getId() { return id_; }
-
- public String getName() { return name_; }
-
- @Override
- public String toString() { return name_; }
-}
diff --git a/src/main/java/com/yahoo/sketches/vector/decomposition/package-info.java b/src/main/java/com/yahoo/sketches/vector/decomposition/package-info.java
deleted file mode 100644
index cea4261..0000000
--- a/src/main/java/com/yahoo/sketches/vector/decomposition/package-info.java
+++ /dev/null
@@ -1,14 +0,0 @@
-/*
- * Copyright 2017, Yahoo! Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root
- * for terms.
- */
-
-/**
- * <p>This package is dedicated to streaming algorithms that enable approximate matrix
- * decompositions.</p>
- *
- * <p>These sketches are mergeable and can be serialized and deserialized to/from a compact
- * form.</p>
- */
-package com.yahoo.sketches.vector.decomposition;
diff --git a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixBuilder.java b/src/main/java/com/yahoo/sketches/vector/matrix/MatrixBuilder.java
deleted file mode 100644
index cbc7a39..0000000
--- a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixBuilder.java
+++ /dev/null
@@ -1,52 +0,0 @@
-/*
- * Copyright 2017, Yahoo! Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root
- * for terms.
- */
-
-package com.yahoo.sketches.vector.matrix;
-
-/**
- * Provides a builder for Matrix objects.
- */
-public class MatrixBuilder {
-
- private MatrixType type_ = MatrixType.OJALGO; // default type
-
- public MatrixBuilder() {}
-
- /**
- * Sets the underlying type of object to use with any Matrix objects created.
- * @param type One of the supported types
- * @return This MatrixBuilder object
- */
- public MatrixBuilder setType(final MatrixType type) {
- type_ = type;
- return this;
- }
-
- /**
- * Returns a value from an enum defining the type of object backing any Matrix objects created.
- * @return An item from the MatrixType enum.
- */
- public MatrixType getBackingType() {
- return type_;
- }
-
- /**
- * Instantiates a new, empty matrix of the target size
- *
- * @param numRows Number of rows in matrix
- * @param numCols Number of columns in matrix
- * @return An empty matrix of the requested size
- */
- public Matrix build(final int numRows, final int numCols) {
- switch (type_) {
- case OJALGO:
- return MatrixImplOjAlgo.newInstance(numRows, numCols);
-
- default:
- throw new IllegalArgumentException("OJALGO is currently the only supported MatrixTypes");
- }
- }
-}
diff --git a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixType.java b/src/main/java/com/yahoo/sketches/vector/matrix/MatrixType.java
deleted file mode 100644
index 7ca7f2b..0000000
--- a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixType.java
+++ /dev/null
@@ -1,20 +0,0 @@
-package com.yahoo.sketches.vector.matrix;
-
-public enum MatrixType {
- OJALGO(1, "ojAlgo");
-
- private int id_;
- private String name_;
-
- MatrixType(final int id, final String name) {
- id_ = id;
- name_ = name;
- }
-
- public int getId() { return id_; }
-
- public String getName() { return name_; }
-
- @Override
- public String toString() { return name_; }
-}
diff --git a/src/main/java/com/yahoo/sketches/vector/matrix/package-info.java b/src/main/java/com/yahoo/sketches/vector/matrix/package-info.java
deleted file mode 100644
index 5a307a9..0000000
--- a/src/main/java/com/yahoo/sketches/vector/matrix/package-info.java
+++ /dev/null
@@ -1,14 +0,0 @@
-/*
- * Copyright 2017, Yahoo! Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root
- * for terms.
- */
-
-/**
- * <p>This package contains a Matrix class that wraps one of several underlying matrix
- * implementations. It can be used to provide a stable public API independent of the
- * specific linear algebra package used for computation.</p>
- *
- * <p>These Matrix objects can be serialized and deserialized to/from a compact form.</p>
- */
-package com.yahoo.sketches.vector.matrix;
diff --git a/src/main/java/com/yahoo/sketches/vector/package-info.java b/src/main/java/com/yahoo/sketches/vector/package-info.java
deleted file mode 100644
index 8f1c2e3..0000000
--- a/src/main/java/com/yahoo/sketches/vector/package-info.java
+++ /dev/null
@@ -1,11 +0,0 @@
-/*
- * Copyright 2017, Yahoo! Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root
- * for terms.
- */
-
-/**
- * This is the parent package for all vector sketch algorithms. Any classes at this level are
- * used by more than one sub-package.
- */
-package com.yahoo.sketches.vector;
diff --git a/src/main/java/com/yahoo/sketches/vector/MatrixFamily.java b/src/main/java/org/apache/datasketches/vector/MatrixFamily.java
similarity index 80%
rename from src/main/java/com/yahoo/sketches/vector/MatrixFamily.java
rename to src/main/java/org/apache/datasketches/vector/MatrixFamily.java
index 22a6954..9c1d141 100644
--- a/src/main/java/com/yahoo/sketches/vector/MatrixFamily.java
+++ b/src/main/java/org/apache/datasketches/vector/MatrixFamily.java
@@ -1,9 +1,23 @@
/*
- * Copyright 2017, Yahoo, Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector;
+package org.apache.datasketches.vector;
import java.util.HashMap;
import java.util.Map;
@@ -27,6 +41,9 @@
* matrix.
*/
MATRIX(128, "Matrix", 2, 3),
+ /**
+ * Select Frequent Directions Family
+ */
FREQUENTDIRECTIONS(129, "FrequentDirections", 2, 4);
@@ -66,7 +83,7 @@
public void checkFamilyID(final int id) {
if (id != id_) {
throw new IllegalArgumentException(
- "Possible Corruption: This Family " + this.toString()
+ "Possible Corruption: This Family " + toString()
+ " does not match the ID of the given Family: " + idToFamily(id).toString());
}
}
diff --git a/src/main/java/com/yahoo/sketches/vector/decomposition/FrequentDirections.java b/src/main/java/org/apache/datasketches/vector/decomposition/FrequentDirections.java
similarity index 83%
rename from src/main/java/com/yahoo/sketches/vector/decomposition/FrequentDirections.java
rename to src/main/java/org/apache/datasketches/vector/decomposition/FrequentDirections.java
index 04c8a9f..c3dff17 100644
--- a/src/main/java/com/yahoo/sketches/vector/decomposition/FrequentDirections.java
+++ b/src/main/java/org/apache/datasketches/vector/decomposition/FrequentDirections.java
@@ -1,38 +1,52 @@
/*
- * Copyright 2017, Yahoo, Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.decomposition;
+package org.apache.datasketches.vector.decomposition;
-import static com.yahoo.memory.UnsafeUtil.LS;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.EMPTY_FLAG_MASK;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.SER_VER;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractFamilyID;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractFlags;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractK;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractN;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractNumColumns;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractNumRows;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractSVAdjustment;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.extractSerVer;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.getAndCheckPreLongs;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertFamilyID;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertFlags;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertK;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertN;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertNumColumns;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertNumRows;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertPreLongs;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertSVAdjustment;
-import static com.yahoo.sketches.vector.decomposition.PreambleUtil.insertSerVer;
+import static org.apache.datasketches.memory.UnsafeUtil.LS;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.EMPTY_FLAG_MASK;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.SER_VER;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractFamilyID;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractFlags;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractK;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractN;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractNumColumns;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractNumRows;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractSVAdjustment;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.extractSerVer;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.getAndCheckPreLongs;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertFamilyID;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertFlags;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertK;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertN;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertNumColumns;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertNumRows;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertPreLongs;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertSVAdjustment;
+import static org.apache.datasketches.vector.decomposition.PreambleUtil.insertSerVer;
-import com.yahoo.memory.Memory;
-import com.yahoo.memory.WritableMemory;
-import com.yahoo.sketches.vector.MatrixFamily;
-import com.yahoo.sketches.vector.matrix.Matrix;
-import com.yahoo.sketches.vector.matrix.MatrixBuilder;
-import com.yahoo.sketches.vector.matrix.MatrixType;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.memory.WritableMemory;
+import org.apache.datasketches.vector.MatrixFamily;
+import org.apache.datasketches.vector.matrix.Matrix;
+import org.apache.datasketches.vector.matrix.MatrixBuilder;
+import org.apache.datasketches.vector.matrix.MatrixType;
/**
* This class implements the Frequent Directions algorithm proposed by Edo Liberty in "Simple and
diff --git a/src/main/java/com/yahoo/sketches/vector/decomposition/MatrixOps.java b/src/main/java/org/apache/datasketches/vector/decomposition/MatrixOps.java
similarity index 65%
rename from src/main/java/com/yahoo/sketches/vector/decomposition/MatrixOps.java
rename to src/main/java/org/apache/datasketches/vector/decomposition/MatrixOps.java
index b0dfcf1..7c5e57c 100644
--- a/src/main/java/com/yahoo/sketches/vector/decomposition/MatrixOps.java
+++ b/src/main/java/org/apache/datasketches/vector/decomposition/MatrixOps.java
@@ -1,15 +1,54 @@
-/* Directly derived from LGPL'd Matrix Toolkit for Java:
- * https://github.com/fommil/matrix-toolkits-java/blob/master/src/main/java/no/uib/cipr/matrix/SVD.java
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.decomposition;
+//License header from the SVD.java file:
+/*
+ * Copyright (C) 2003-2006 Bjørn-Ove Heimsund
+ *
+ * This file is part of MTJ.
+ *
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by the
+ * Free Software Foundation; either version 2.1 of the License, or (at your
+ * option) any later version.
+ *
+ * This library 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 Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
-import com.yahoo.sketches.vector.matrix.Matrix;
+
+package org.apache.datasketches.vector.decomposition;
+
+import org.apache.datasketches.vector.matrix.Matrix;
/**
- * Computes singular value decompositions and related Matrix operations needed by Frequent Directions. May
- * return as many singular values as exist, but other operations will limit output to k dimensions.
+ * Computes singular value decompositions and related Matrix operations needed by Frequent Directions.
+ * May return as many singular values as exist, but other operations will limit output to k dimensions.
*/
+// Directly derived from LGPL'd Matrix Toolkit for Java (MTL):
+// https://github.com/fommil/matrix-toolkits-java/blob/master/src/main/java/no/uib/cipr/matrix/SVD.java
abstract class MatrixOps {
// iterations for SISVD
diff --git a/src/main/java/com/yahoo/sketches/vector/decomposition/MatrixOpsImplOjAlgo.java b/src/main/java/org/apache/datasketches/vector/decomposition/MatrixOpsImplOjAlgo.java
similarity index 81%
rename from src/main/java/com/yahoo/sketches/vector/decomposition/MatrixOpsImplOjAlgo.java
rename to src/main/java/org/apache/datasketches/vector/decomposition/MatrixOpsImplOjAlgo.java
index 57dfc3e..4c1f8d1 100644
--- a/src/main/java/com/yahoo/sketches/vector/decomposition/MatrixOpsImplOjAlgo.java
+++ b/src/main/java/org/apache/datasketches/vector/decomposition/MatrixOpsImplOjAlgo.java
@@ -1,4 +1,23 @@
-package com.yahoo.sketches.vector.decomposition;
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.datasketches.vector.decomposition;
import java.util.Optional;
@@ -10,9 +29,8 @@
import org.ojalgo.matrix.store.SparseStore;
import org.ojalgo.random.Normal;
-import com.yahoo.sketches.vector.matrix.Matrix;
-import com.yahoo.sketches.vector.matrix.MatrixImplOjAlgo;
-import com.yahoo.sketches.vector.matrix.MatrixType;
+import org.apache.datasketches.vector.matrix.Matrix;
+import org.apache.datasketches.vector.matrix.MatrixType;
class MatrixOpsImplOjAlgo extends MatrixOps {
private double[] sv_;
@@ -25,7 +43,7 @@
// work objects for Symmetric EVD
private Eigenvalue<Double> evd_;
-
+
// work object for full SVD
private SingularValue<Double> svd_;
@@ -49,7 +67,7 @@
throw new IllegalArgumentException("A.numColumns() != d_");
}
- if (computeVectors && Vt_ == null) {
+ if (computeVectors && (Vt_ == null)) {
Vt_ = PrimitiveDenseStore.FACTORY.makeZero(n_, d_);
S_ = SparseStore.makePrimitive(sv_.length, sv_.length);
}
@@ -79,7 +97,7 @@
@Override
Matrix getVt() {
- return MatrixImplOjAlgo.wrap(Vt_);
+ return Matrix.wrap(Vt_);
}
@Override
@@ -92,9 +110,9 @@
double medianSVSq = sv_[k_ - 1]; // (l_/2)th item, not yet squared
medianSVSq *= medianSVSq;
svAdjustment += medianSVSq; // always track, even if not using compensative mode
- for (int i = 0; i < k_ - 1; ++i) {
+ for (int i = 0; i < (k_ - 1); ++i) {
final double val = sv_[i];
- final double adjSqSV = val * val - medianSVSq;
+ final double adjSqSV = (val * val) - medianSVSq;
S_.set(i, i, adjSqSV < 0 ? 0.0 : Math.sqrt(adjSqSV)); // just to be safe
}
for (int i = k_ - 1; i < S_.countColumns(); ++i) {
@@ -125,9 +143,9 @@
= PrimitiveDenseStore.FACTORY.copy((PrimitiveDenseStore) A.getRawObject());
svd(Matrix.wrap(result), true);
- for (int i = 0; i < k_ - 1; ++i) {
+ for (int i = 0; i < (k_ - 1); ++i) {
final double val = sv_[i];
- final double adjSV = Math.sqrt(val * val + svAdjustment);
+ final double adjSV = Math.sqrt((val * val) + svAdjustment);
S_.set(i, i, adjSV);
}
for (int i = k_ - 1; i < S_.countColumns(); ++i) {
@@ -204,7 +222,7 @@
for (int i = 0; i < ev.length; ++i) {
final double val = Math.sqrt(ev[i]);
sv_[i] = val;
- if (computeVectors && val > 0) { S_.set(i, i, 1 / val); }
+ if (computeVectors && (val > 0)) { S_.set(i, i, 1 / val); }
}
if (computeVectors) {
diff --git a/src/main/java/com/yahoo/sketches/vector/decomposition/PreambleUtil.java b/src/main/java/org/apache/datasketches/vector/decomposition/PreambleUtil.java
similarity index 88%
rename from src/main/java/com/yahoo/sketches/vector/decomposition/PreambleUtil.java
rename to src/main/java/org/apache/datasketches/vector/decomposition/PreambleUtil.java
index 0de11d3..6d2762c 100644
--- a/src/main/java/com/yahoo/sketches/vector/decomposition/PreambleUtil.java
+++ b/src/main/java/org/apache/datasketches/vector/decomposition/PreambleUtil.java
@@ -1,14 +1,28 @@
/*
- * Copyright 2017, Yahoo, Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.decomposition;
+package org.apache.datasketches.vector.decomposition;
-import static com.yahoo.memory.UnsafeUtil.unsafe;
+import static org.apache.datasketches.memory.UnsafeUtil.unsafe;
-import com.yahoo.memory.Memory;
-import com.yahoo.sketches.vector.MatrixFamily;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.vector.MatrixFamily;
/**
* This class defines the preamble items structure and provides basic utilities for some of the key fields.
diff --git a/src/main/java/org/apache/datasketches/vector/decomposition/SVDAlgo.java b/src/main/java/org/apache/datasketches/vector/decomposition/SVDAlgo.java
new file mode 100644
index 0000000..25db3c6
--- /dev/null
+++ b/src/main/java/org/apache/datasketches/vector/decomposition/SVDAlgo.java
@@ -0,0 +1,75 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.datasketches.vector.decomposition;
+
+/**
+ * This class allows a choice of algorithms for Singular Value Decomposition. The options are:
+ * <ul>
+ * <li>FULL: The matrix library's default SVD implementation.</li>
+ * <li>SISVD: Simultaneous iteration, an approximate method likely to be more efficient only with sparse
+ * matrices or when <em>k</em> is significantly smaller than the number of rows in the sketch.</li>
+ * <li>SYM: Takes advantage of matrix dimensionality, first computing eigenvalues of AA^T, then computes
+ * intended results. Squaring A alters condition number and may cause numeric stability issues,
+ * but unlikely an issue for Frequent Directions since discarding the smaller singular values/vectors.</li>
+ * </ul>
+ */
+public enum SVDAlgo {
+
+ /**
+ * The matrix library's default SVD implementation.
+ */
+ FULL(1, "Full"),
+
+ /**
+ * Simultaneous iteration, an approximate method likely to be more efficient only with sparse
+ * matrices or when <em>k</em> is significantly smaller than the number of rows in the sketch.
+ */
+ SISVD(2, "SISVD"),
+
+ /**
+ * Takes advantage of matrix dimensionality, first computing eigenvalues of AA^T, then computes
+ * intended results. Squaring A alters condition number and may cause numeric stability issues,
+ * but unlikely an issue for Frequent Directions since discarding the smaller singular values/vectors.
+ */
+ SYM(3, "Symmetrized");
+
+ private int id_;
+ private String name_;
+
+ SVDAlgo(final int id, final String name) {
+ id_ = id;
+ name_ = name;
+ }
+
+ /**
+ * Returns the ID.
+ * @return the ID.
+ */
+ public int getId() { return id_; }
+
+ /**
+ * Gets the name
+ * @return the name
+ */
+ public String getName() { return name_; }
+
+ @Override
+ public String toString() { return name_; }
+}
diff --git a/src/main/java/org/apache/datasketches/vector/decomposition/package-info.java b/src/main/java/org/apache/datasketches/vector/decomposition/package-info.java
new file mode 100644
index 0000000..0a03e12
--- /dev/null
+++ b/src/main/java/org/apache/datasketches/vector/decomposition/package-info.java
@@ -0,0 +1,27 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * <p>This package is dedicated to streaming algorithms that enable approximate matrix
+ * decompositions.</p>
+ *
+ * <p>These sketches are mergeable and can be serialized and deserialized to/from a compact
+ * form.</p>
+ */
+package org.apache.datasketches.vector.decomposition;
diff --git a/src/main/java/com/yahoo/sketches/vector/matrix/Matrix.java b/src/main/java/org/apache/datasketches/vector/matrix/Matrix.java
similarity index 83%
rename from src/main/java/com/yahoo/sketches/vector/matrix/Matrix.java
rename to src/main/java/org/apache/datasketches/vector/matrix/Matrix.java
index a1eb8ef..284eee6 100644
--- a/src/main/java/com/yahoo/sketches/vector/matrix/Matrix.java
+++ b/src/main/java/org/apache/datasketches/vector/matrix/Matrix.java
@@ -1,17 +1,30 @@
/*
- * Copyright 2017, Yahoo! Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root
- * for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.matrix;
+package org.apache.datasketches.vector.matrix;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.LS;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.LS;
import org.ojalgo.matrix.store.PrimitiveDenseStore;
-import com.yahoo.memory.Memory;
-import com.yahoo.sketches.vector.MatrixFamily;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.vector.MatrixFamily;
/**
* Provides an implementation-agnostic wrapper around Matrix classes.
@@ -164,9 +177,9 @@
final int nRows = Math.min(rows, numRows_);
final int nCols = Math.min(cols, numCols_);
- if (nRows < 1 || nCols < 1) {
+ if ((nRows < 1) || (nCols < 1)) {
return MatrixFamily.MATRIX.getMinPreLongs() * Long.BYTES;
- } else if (nRows == numRows_ && nCols == numCols_) {
+ } else if ((nRows == numRows_) && (nCols == numCols_)) {
return getSizeBytes();
}
@@ -213,5 +226,9 @@
return sb.toString();
}
+ /**
+ * Gets the matrix type
+ * @return the matrix type
+ */
public abstract MatrixType getMatrixType();
}
diff --git a/src/main/java/org/apache/datasketches/vector/matrix/MatrixBuilder.java b/src/main/java/org/apache/datasketches/vector/matrix/MatrixBuilder.java
new file mode 100644
index 0000000..a9ada47
--- /dev/null
+++ b/src/main/java/org/apache/datasketches/vector/matrix/MatrixBuilder.java
@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.datasketches.vector.matrix;
+
+/**
+ * Provides a builder for Matrix objects.
+ */
+public class MatrixBuilder {
+
+ private MatrixType type_ = MatrixType.OJALGO; // default type
+
+ /**
+ * Default no-op constructor.
+ */
+ public MatrixBuilder() {}
+
+ /**
+ * Sets the underlying type of object to use with any Matrix objects created.
+ * @param type One of the supported types
+ * @return This MatrixBuilder object
+ */
+ public MatrixBuilder setType(final MatrixType type) {
+ type_ = type;
+ return this;
+ }
+
+ /**
+ * Returns a value from an enum defining the type of object backing any Matrix objects created.
+ * @return An item from the MatrixType enum.
+ */
+ public MatrixType getBackingType() {
+ return type_;
+ }
+
+ /**
+ * Instantiates a new, empty matrix of the target size
+ *
+ * @param numRows Number of rows in matrix
+ * @param numCols Number of columns in matrix
+ * @return An empty matrix of the requested size
+ */
+ public Matrix build(final int numRows, final int numCols) {
+ switch (type_) {
+ case OJALGO:
+ return MatrixImplOjAlgo.newInstance(numRows, numCols);
+
+ default:
+ throw new IllegalArgumentException("OJALGO is currently the only supported MatrixTypes");
+ }
+ }
+}
diff --git a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixImplOjAlgo.java b/src/main/java/org/apache/datasketches/vector/matrix/MatrixImplOjAlgo.java
similarity index 77%
rename from src/main/java/com/yahoo/sketches/vector/matrix/MatrixImplOjAlgo.java
rename to src/main/java/org/apache/datasketches/vector/matrix/MatrixImplOjAlgo.java
index 726f239..590ddcb 100644
--- a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixImplOjAlgo.java
+++ b/src/main/java/org/apache/datasketches/vector/matrix/MatrixImplOjAlgo.java
@@ -1,27 +1,43 @@
/*
- * Copyright 2017, Yahoo! Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root
- * for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.matrix;
+package org.apache.datasketches.vector.matrix;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.COMPACT_FLAG_MASK;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractFamilyID;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractFlags;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractNumColumns;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractNumColumnsUsed;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractNumRows;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractNumRowsUsed;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractPreLongs;
-import static com.yahoo.sketches.vector.matrix.MatrixPreambleUtil.extractSerVer;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.COMPACT_FLAG_MASK;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractFamilyID;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractFlags;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractNumColumns;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractNumColumnsUsed;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractNumRows;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractNumRowsUsed;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractPreLongs;
+import static org.apache.datasketches.vector.matrix.MatrixPreambleUtil.extractSerVer;
import org.ojalgo.matrix.store.PrimitiveDenseStore;
-import com.yahoo.memory.Memory;
-import com.yahoo.memory.WritableMemory;
-import com.yahoo.sketches.vector.MatrixFamily;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.memory.WritableMemory;
+import org.apache.datasketches.vector.MatrixFamily;
+/**
+ * Implements the OJ-Algo Matrix operations.
+ */
public final class MatrixImplOjAlgo extends Matrix {
private PrimitiveDenseStore mtx_;
diff --git a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixPreambleUtil.java b/src/main/java/org/apache/datasketches/vector/matrix/MatrixPreambleUtil.java
similarity index 88%
rename from src/main/java/com/yahoo/sketches/vector/matrix/MatrixPreambleUtil.java
rename to src/main/java/org/apache/datasketches/vector/matrix/MatrixPreambleUtil.java
index 8110b8f..efa79f1 100644
--- a/src/main/java/com/yahoo/sketches/vector/matrix/MatrixPreambleUtil.java
+++ b/src/main/java/org/apache/datasketches/vector/matrix/MatrixPreambleUtil.java
@@ -1,14 +1,28 @@
/*
- * Copyright 2017, Yahoo, Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.matrix;
+package org.apache.datasketches.vector.matrix;
-import static com.yahoo.memory.UnsafeUtil.unsafe;
+import static org.apache.datasketches.memory.UnsafeUtil.unsafe;
-import com.yahoo.memory.Memory;
-import com.yahoo.sketches.vector.MatrixFamily;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.vector.MatrixFamily;
/**
* This class defines the preamble items structure and provides basic utilities for some of the
diff --git a/src/main/java/org/apache/datasketches/vector/matrix/MatrixType.java b/src/main/java/org/apache/datasketches/vector/matrix/MatrixType.java
new file mode 100644
index 0000000..8f2564e
--- /dev/null
+++ b/src/main/java/org/apache/datasketches/vector/matrix/MatrixType.java
@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.datasketches.vector.matrix;
+
+/**
+ * The MatrixType enum
+ */
+public enum MatrixType {
+ /**
+ * Select the ojAlgo
+ */
+ OJALGO(1, "ojAlgo");
+
+ private int id_;
+ private String name_;
+
+ MatrixType(final int id, final String name) {
+ id_ = id;
+ name_ = name;
+ }
+
+ /**
+ * Gets the ID
+ * @return the ID
+ */
+ public int getId() { return id_; }
+
+ /**
+ * Gets the name
+ * @return the name
+ */
+ public String getName() { return name_; }
+
+ @Override
+ public String toString() { return name_; }
+}
diff --git a/src/main/java/org/apache/datasketches/vector/matrix/package-info.java b/src/main/java/org/apache/datasketches/vector/matrix/package-info.java
new file mode 100644
index 0000000..125d023
--- /dev/null
+++ b/src/main/java/org/apache/datasketches/vector/matrix/package-info.java
@@ -0,0 +1,27 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * <p>This package contains a Matrix class that wraps one of several underlying matrix
+ * implementations. It can be used to provide a stable public API independent of the
+ * specific linear algebra package used for computation.</p>
+ *
+ * <p>These Matrix objects can be serialized and deserialized to/from a compact form.</p>
+ */
+package org.apache.datasketches.vector.matrix;
diff --git a/src/main/java/org/apache/datasketches/vector/package-info.java b/src/main/java/org/apache/datasketches/vector/package-info.java
new file mode 100644
index 0000000..6a2db18
--- /dev/null
+++ b/src/main/java/org/apache/datasketches/vector/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * This is the parent package for all vector sketch algorithms. Any classes at this level are
+ * used by more than one sub-package.
+ */
+package org.apache.datasketches.vector;
diff --git a/src/test/java/com/yahoo/sketches/vector/matrix/MatrixBuilderTest.java b/src/test/java/com/yahoo/sketches/vector/matrix/MatrixBuilderTest.java
deleted file mode 100644
index 4beb32b..0000000
--- a/src/test/java/com/yahoo/sketches/vector/matrix/MatrixBuilderTest.java
+++ /dev/null
@@ -1,36 +0,0 @@
-/*
- * Copyright 2017, Yahoo! Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root
- * for terms.
- */
-
-package com.yahoo.sketches.vector.matrix;
-
-import static org.testng.Assert.assertEquals;
-import static org.testng.Assert.assertNotNull;
-
-import org.testng.annotations.Test;
-
-public class MatrixBuilderTest {
- @Test
- public void checkBuild() {
- final MatrixBuilder builder = new MatrixBuilder();
- assertEquals(builder.getBackingType(), MatrixType.OJALGO); // default type
-
- Matrix m = builder.build(128, 512);
- assertNotNull(m);
-
- m = builder.build(128, 512);
- assertNotNull(m);
- }
-
- @Test
- public void checkSetType() {
- final MatrixBuilder builder = new MatrixBuilder();
- final MatrixType type = builder.getBackingType();
- assertEquals(type, MatrixType.OJALGO); // default type
- assertEquals(type.getId(), MatrixType.OJALGO.getId());
- assertEquals(type.getName(), MatrixType.OJALGO.getName());
- }
-
-}
diff --git a/src/test/java/com/yahoo/sketches/vector/decomposition/FrequentDirectionsTest.java b/src/test/java/org/apache/datasketches/vector/decomposition/FrequentDirectionsTest.java
similarity index 88%
rename from src/test/java/com/yahoo/sketches/vector/decomposition/FrequentDirectionsTest.java
rename to src/test/java/org/apache/datasketches/vector/decomposition/FrequentDirectionsTest.java
index d9485b3..e14e757 100644
--- a/src/test/java/com/yahoo/sketches/vector/decomposition/FrequentDirectionsTest.java
+++ b/src/test/java/org/apache/datasketches/vector/decomposition/FrequentDirectionsTest.java
@@ -1,9 +1,23 @@
/*
- * Copyright 2017, Yahoo, Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.decomposition;
+package org.apache.datasketches.vector.decomposition;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
@@ -15,12 +29,14 @@
import org.testng.annotations.Test;
-import com.yahoo.memory.Memory;
-import com.yahoo.memory.WritableMemory;
-import com.yahoo.sketches.vector.MatrixFamily;
-import com.yahoo.sketches.vector.matrix.Matrix;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.memory.WritableMemory;
+import org.apache.datasketches.vector.MatrixFamily;
+import org.apache.datasketches.vector.matrix.Matrix;
+@SuppressWarnings("javadoc")
public class FrequentDirectionsTest {
+
@Test
public void instantiateFD() {
final int k = 32;
@@ -80,7 +96,7 @@
runUpdateTest(fd);
}
- private void runUpdateTest(final FrequentDirections fd) {
+ private static void runUpdateTest(final FrequentDirections fd) {
final int k = fd.getK();
final int d = fd.getD();
@@ -151,7 +167,7 @@
assertEquals(fd2.getN(), initialRows);
fd1.update(fd2);
- final int expectedRows = ((2 * initialRows) % k) + k - 1; // assumes 2 * initialRows > k
+ final int expectedRows = (((2 * initialRows) % k) + k) - 1; // assumes 2 * initialRows > k
assertEquals(fd1.getNumRows(), expectedRows);
assertEquals(fd1.getN(), 2 * initialRows);
@@ -182,7 +198,7 @@
runCompensativeResultTest(fd);
}
- private void runCompensativeResultTest(final FrequentDirections fd) {
+ private static void runCompensativeResultTest(final FrequentDirections fd) {
final int d = fd.getD();
final int k = fd.getK();
diff --git a/src/test/java/com/yahoo/sketches/vector/decomposition/MatrixOpsTest.java b/src/test/java/org/apache/datasketches/vector/decomposition/MatrixOpsTest.java
similarity index 70%
rename from src/test/java/com/yahoo/sketches/vector/decomposition/MatrixOpsTest.java
rename to src/test/java/org/apache/datasketches/vector/decomposition/MatrixOpsTest.java
index b8ea789..2288c07 100644
--- a/src/test/java/com/yahoo/sketches/vector/decomposition/MatrixOpsTest.java
+++ b/src/test/java/org/apache/datasketches/vector/decomposition/MatrixOpsTest.java
@@ -1,14 +1,34 @@
-package com.yahoo.sketches.vector.decomposition;
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.datasketches.vector.decomposition;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.fail;
import org.testng.annotations.Test;
-import com.yahoo.sketches.vector.matrix.Matrix;
-import com.yahoo.sketches.vector.matrix.MatrixBuilder;
-import com.yahoo.sketches.vector.matrix.MatrixType;
+import org.apache.datasketches.vector.matrix.Matrix;
+import org.apache.datasketches.vector.matrix.MatrixBuilder;
+import org.apache.datasketches.vector.matrix.MatrixType;
+@SuppressWarnings("javadoc")
public class MatrixOpsTest {
@Test
@@ -51,7 +71,7 @@
final Matrix A = generateIncreasingEye(d, 2 * k);
final MatrixOps mo = MatrixOps.newInstance(A, SVDAlgo.FULL, k);
- Matrix B = generateIncreasingEye(d, 2 * k + 1);
+ Matrix B = generateIncreasingEye(d, (2 * k) + 1);
try {
mo.svd(B, true);
fail();
@@ -69,7 +89,7 @@
}
- private void compareSingularValues(final double[] A, final double[] B, final int n) {
+ private static void compareSingularValues(final double[] A, final double[] B, final int n) {
assertEquals(A.length, B.length);
for (int i = 0; i < n; ++i) {
@@ -78,7 +98,7 @@
}
- private void compareMatrixElementMagnitudes(final Matrix A, final Matrix B, final int n) {
+ private static void compareMatrixElementMagnitudes(final Matrix A, final Matrix B, final int n) {
assertEquals(A.getNumColumns(), B.getNumColumns());
assertEquals(A.getNumRows(), B.getNumRows());
diff --git a/src/test/java/org/apache/datasketches/vector/matrix/MatrixBuilderTest.java b/src/test/java/org/apache/datasketches/vector/matrix/MatrixBuilderTest.java
new file mode 100644
index 0000000..2de3326
--- /dev/null
+++ b/src/test/java/org/apache/datasketches/vector/matrix/MatrixBuilderTest.java
@@ -0,0 +1,50 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.datasketches.vector.matrix;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNotNull;
+
+import org.testng.annotations.Test;
+
+@SuppressWarnings("javadoc")
+public class MatrixBuilderTest {
+ @Test
+ public void checkBuild() {
+ final MatrixBuilder builder = new MatrixBuilder();
+ assertEquals(builder.getBackingType(), MatrixType.OJALGO); // default type
+
+ Matrix m = builder.build(128, 512);
+ assertNotNull(m);
+
+ m = builder.build(128, 512);
+ assertNotNull(m);
+ }
+
+ @Test
+ public void checkSetType() {
+ final MatrixBuilder builder = new MatrixBuilder();
+ final MatrixType type = builder.getBackingType();
+ assertEquals(type, MatrixType.OJALGO); // default type
+ assertEquals(type.getId(), MatrixType.OJALGO.getId());
+ assertEquals(type.getName(), MatrixType.OJALGO.getName());
+ }
+
+}
diff --git a/src/test/java/com/yahoo/sketches/vector/matrix/MatrixImplOjAlgoTest.java b/src/test/java/org/apache/datasketches/vector/matrix/MatrixImplOjAlgoTest.java
similarity index 85%
rename from src/test/java/com/yahoo/sketches/vector/matrix/MatrixImplOjAlgoTest.java
rename to src/test/java/org/apache/datasketches/vector/matrix/MatrixImplOjAlgoTest.java
index c745587..ab76ea5 100644
--- a/src/test/java/com/yahoo/sketches/vector/matrix/MatrixImplOjAlgoTest.java
+++ b/src/test/java/org/apache/datasketches/vector/matrix/MatrixImplOjAlgoTest.java
@@ -1,9 +1,23 @@
/*
- * Copyright 2017, Yahoo, Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.matrix;
+package org.apache.datasketches.vector.matrix;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.fail;
@@ -11,10 +25,12 @@
import org.ojalgo.matrix.store.PrimitiveDenseStore;
import org.testng.annotations.Test;
-import com.yahoo.memory.Memory;
-import com.yahoo.memory.WritableMemory;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.memory.WritableMemory;
+@SuppressWarnings("javadoc")
public class MatrixImplOjAlgoTest {
+
@Test
public void checkInstantiation() {
final int nRows = 10;
diff --git a/src/test/java/com/yahoo/sketches/vector/matrix/MatrixTest.java b/src/test/java/org/apache/datasketches/vector/matrix/MatrixTest.java
similarity index 81%
rename from src/test/java/com/yahoo/sketches/vector/matrix/MatrixTest.java
rename to src/test/java/org/apache/datasketches/vector/matrix/MatrixTest.java
index 8be75cc..3943ab7 100644
--- a/src/test/java/com/yahoo/sketches/vector/matrix/MatrixTest.java
+++ b/src/test/java/org/apache/datasketches/vector/matrix/MatrixTest.java
@@ -1,9 +1,23 @@
/*
- * Copyright 2017, Yahoo, Inc.
- * Licensed under the terms of the Apache License 2.0. See LICENSE file at the project root for terms.
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-package com.yahoo.sketches.vector.matrix;
+package org.apache.datasketches.vector.matrix;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
@@ -13,10 +27,11 @@
import org.testng.annotations.Test;
-import com.yahoo.memory.Memory;
-import com.yahoo.memory.WritableMemory;
-import com.yahoo.sketches.vector.MatrixFamily;
+import org.apache.datasketches.memory.Memory;
+import org.apache.datasketches.memory.WritableMemory;
+import org.apache.datasketches.vector.MatrixFamily;
+@SuppressWarnings("javadoc")
public class MatrixTest {
@Test
diff --git a/tools/CloverConfig.txt b/tools/CloverConfig.txt
deleted file mode 100644
index 9e0ec43..0000000
--- a/tools/CloverConfig.txt
+++ /dev/null
@@ -1,33 +0,0 @@
-Clover Config for Eclipse:
-
-At Project Level Properties:
-Clover:
- Instrumentation:
- Initstring: Default value
- Output Folder: ...project output dir(s)
- Flush Policy: At JVM shutdown ...
- Misc: Fully qualify ... , Instrument and compile at statement level
- Contexts:
- Check: assert statements
- Add Custom Coverage Context Filter:
- private-constructor: also see link below
- Method
- (.* )?private +[a-zA-Z0-9_$]+ *\( *\).*
- Source Files
- Only look ...
- [check] src/main/java[includes=**/*.java][excludes=]
- [check] src/test/java[includes=**/*.java][excludes=]
- Test Classes
- Assume all source in the specified folders are tests or test utility classes
- [check] src/test/java
-
-At Clover "down-triangle" menu:
- Columns:
- Element
- % TOTAL Coverage
- Uncovered Elements: Custom: %UncoveredElements * TotalElements / 100
- Total Elements
-
-
-
-http://alexruizlog.blogspot.com/2009/04/how-to-make-clover-ignore-private_21.html
\ No newline at end of file
diff --git a/tools/FindBugsExcludeFilter.xml b/tools/FindBugsExcludeFilter.xml
index 16e5fa3..3a0bef8 100644
--- a/tools/FindBugsExcludeFilter.xml
+++ b/tools/FindBugsExcludeFilter.xml
@@ -1,3 +1,22 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
<FindBugsFilter> <!-- sketches-core -->
<!-- Too many false positives to be useful. I could not make it happy :( -->
diff --git a/tools/SketchesCheckstyle.xml b/tools/SketchesCheckstyle.xml
index 0a67506..f65c1cd 100644
--- a/tools/SketchesCheckstyle.xml
+++ b/tools/SketchesCheckstyle.xml
@@ -4,6 +4,25 @@
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> <!-- does not work with https -->
<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<!--
SketchesCheckstyle.xml for sketches-core
Checkstyle is very configurable. Be sure to read the documentation at
