Author: echatellier Date: 2010-12-17 10:38:15 +0100 (Fri, 17 Dec 2010) New Revision: 319 Url: http://nuiton.org/repositories/revision/nuiton-matrix/319 Log: Update javadoc and site Added: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/gui/package-info.java trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/package-info.java trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/jfreechart/package-info.java trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/package-info.java trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/package-info.java Modified: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/MatrixChartRenderer.java trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/MatrixND.java trunk/src/site/rst/index.rst Modified: trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/MatrixND.java =================================================================== --- trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/MatrixND.java 2010-12-16 17:21:23 UTC (rev 318) +++ trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/MatrixND.java 2010-12-17 09:38:15 UTC (rev 319) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2004 - 2010 CodeLutin + * Copyright (C) 2004 - 2010 CodeLutin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -32,7 +32,7 @@ import java.util.List; /** - * MatrixND. + * MatrixND interface for different matrix implementation. * * Created: 29 oct. 2004 * @@ -63,7 +63,7 @@ public List<?>[] getSemantics(); /** - * Retourne la semantique pour une dimension + * Retourne la semantique pour une dimension. * * @param dim la dimension pour lequel on veut la semantique * @return la semantique de la dimension on null s'il n'y a pas de @@ -75,7 +75,7 @@ public List<?> getSemantics(int dim); /** - * Retourne la semantique pour une dimension + * Retourne la semantique pour une dimension. * * @param dim la dimension pour lequel on veut la semantique * @return la semantique de la dimension on null s'il n'y a pas de @@ -84,23 +84,24 @@ public List<?> getSemantic(int dim); /** - * Modifie la semantique d'une dimension + * Modifie la semantique d'une dimension. * * @param <E> data type * @param dim dimension to modify semantic * @param sem new semantic to set * - * @deprecated use #setSemantics(int, List<E>) instead + * @deprecated (since 1.0.3) use #setSemantics(int, List<E>) instead */ @Deprecated public <E> void setSemantics(int dim, List<E> sem); /** - * Modifie la semantique d'une dimension + * Modifie la semantique d'une dimension. * * @param <E> data type * @param dim dimension to modify semantic * @param sem new semantic to set + * @since 1.0.3 */ public <E> void setSemantic(int dim, List<E> sem); @@ -112,7 +113,7 @@ public void setName(String name); /** - * Retourne le nom de la matrice + * Retourne le nom de la matrice. * * @return le nom de la matrice ou la chaine vide si pas de nom. */ @@ -122,8 +123,7 @@ * Permet de mettre des noms aux différentes dimension. * * @param names names to set - * - * @deprecated (since 1.0.3) Use #setDimensionNames(String[]) + * @deprecated since 1.0.3, use {@link #setDimensionNames(String[])} instead */ @Deprecated public void setDimensionName(String[] names); @@ -132,7 +132,6 @@ * Permet de mettre des noms aux différentes dimension. * * @param names names to set - * * @since 1.0.3 */ public void setDimensionNames(String[] names); @@ -142,7 +141,7 @@ * * @return tableau des noms de dimension. * - * @deprecated (since 1.0.3) Use #getDimensionNames() + * @deprecated since 1.0.3, use {@link #getDimensionNames()} instead */ @Deprecated public String[] getDimensionName(); @@ -151,7 +150,6 @@ * Permet de recuperer les noms des dimension. * * @return tableau des noms de dimension. - * * @since 1.0.3 */ public String[] getDimensionNames(); @@ -165,7 +163,7 @@ public void setDimensionName(int dim, String name); /** - * Retourne le nom de la dimension demandé. + * Retourne le nom de la dimension demandée. * * @param dim la dimension dont on veut le nom * @return le nom de la dimension ou la chaine vide si la dimension n'a pas @@ -174,7 +172,7 @@ public String getDimensionName(int dim); /** - * Retourne la valeur la plus courrement rencontrer dans un tableau. si + * Retourne la valeur la plus couramment rencontree dans un tableau. Si * plusieurs valeurs ont le même nombre d'occurrence la plus petite valeur * est retourné. * @@ -186,11 +184,12 @@ public double getMaxOccurence(); /** - * Retourne la valeur la plus courrement rencontrer dans un tableau. si + * Retourne la valeur la plus courrement rencontrer dans un tableau. Si * plusieurs valeurs ont le même nombre d'occurrence la plus petite valeur * est retourné. * * @return la valeur la plus nombreuse dans le tableau + * @since 2.1 */ public double getMaxOccurrence(); @@ -198,7 +197,7 @@ * Retourne le nombre de dimensions de la matrice. * * @return le nombre de dimensions de la matrice. - * @deprecated use #getDimCount() instead + * @deprecated since 1.0.3, use {@link #getDimCount()} instead */ public int getNbDim(); @@ -206,6 +205,7 @@ * Retourne le nombre de dimensions de la matrice. * * @return le nombre de dimensions de la matrice. + * @since 1.0.3 */ public int getDimCount(); @@ -235,7 +235,7 @@ * Applique une fonction sur chaque valeur de la matrice. * * @param f function to apply - * @return <tt>this</tt> + * @return {@code this} */ public MatrixND map(MapFunction f); Added: trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/package-info.java =================================================================== --- trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/package-info.java (rev 0) +++ trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/package-info.java 2010-12-17 09:38:15 UTC (rev 319) @@ -0,0 +1,26 @@ +/* + * #%L + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2004 - 2010 CodeLutin, Chatellier Eric + * %% + * This program 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 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ +/** + * Nuiton matrix api. + */ +package org.nuiton.math.matrix; Property changes on: trunk/nuiton-matrix/src/main/java/org/nuiton/math/matrix/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/gui/package-info.java =================================================================== --- trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/gui/package-info.java (rev 0) +++ trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/gui/package-info.java 2010-12-17 09:38:15 UTC (rev 319) @@ -0,0 +1,26 @@ +/* + * #%L + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2004 - 2010 CodeLutin, Chatellier Eric + * %% + * This program 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 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ +/** + * Nuiton matrix panel. + */ +package org.nuiton.math.matrix.gui; Property changes on: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/gui/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/package-info.java =================================================================== --- trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/package-info.java (rev 0) +++ trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/package-info.java 2010-12-17 09:38:15 UTC (rev 319) @@ -0,0 +1,26 @@ +/* + * #%L + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2004 - 2010 CodeLutin, Chatellier Eric + * %% + * This program 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 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ +/** + * Nuiton matrix viewer. + */ +package org.nuiton.math.matrix.viewer; Property changes on: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Modified: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/MatrixChartRenderer.java =================================================================== --- trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/MatrixChartRenderer.java 2010-12-16 17:21:23 UTC (rev 318) +++ trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/MatrixChartRenderer.java 2010-12-17 09:38:15 UTC (rev 319) @@ -102,9 +102,10 @@ } /** - * Chart renderer combo box. + * Chart renderers combo box. * - * @return + * @return chart renderers combo box + * @see CategoryItemRenderer */ protected JComboBox getChartRendererComboBox() { JComboBox rendererComboBox = new JComboBox(); @@ -125,10 +126,11 @@ } /** - * Data model. + * JFreechart data model. * * @param matrix - * @return + * @return jfreechart data model + * @see CategoryDataset */ protected CategoryDataset getCategoryDataset(MatrixND matrix) { CategoryDataset categoryDataset = new GraphMatrixNDDataset(matrix); @@ -139,7 +141,7 @@ * Abscisse (nom + valeur à la verticale). * * @param matrix - * @return + * @return category axis */ protected CategoryAxis getCategoryAxis(MatrixND matrix) { CategoryAxis horizontalAxis = new CategoryAxis(); @@ -152,7 +154,7 @@ * Ordonnées (valeur seule). * * @param matrix - * @return + * @return value axis */ protected ValueAxis getValueAxis(MatrixND matrix) { ValueAxis verticalAxis = new NumberAxis3D(); @@ -160,10 +162,10 @@ } /** - * Plot. + * Category plot. * * @param matrix - * @return + * @return category plot */ protected CategoryPlot getCategoryPlot(MatrixND matrix) { CategoryPlot categoryPlot = new CategoryPlot(getCategoryDataset(matrix), @@ -175,7 +177,7 @@ /** * Build chart. * - * @return + * @return chart */ protected JFreeChart getJFreeChart(MatrixND matrix) { JFreeChart chart = new JFreeChart(_(matrix.getName()), JFreeChart.DEFAULT_TITLE_FONT, getCategoryPlot(matrix), true); Added: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/jfreechart/package-info.java =================================================================== --- trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/jfreechart/package-info.java (rev 0) +++ trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/jfreechart/package-info.java 2010-12-17 09:38:15 UTC (rev 319) @@ -0,0 +1,26 @@ +/* + * #%L + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2004 - 2010 CodeLutin, Chatellier Eric + * %% + * This program 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 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ +/** + * Nuiton matrix viewer renderers. + */ +package org.nuiton.math.matrix.viewer.renderer.jfreechart; Property changes on: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/jfreechart/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/package-info.java =================================================================== --- trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/package-info.java (rev 0) +++ trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/package-info.java 2010-12-17 09:38:15 UTC (rev 319) @@ -0,0 +1,26 @@ +/* + * #%L + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2004 - 2010 CodeLutin, Chatellier Eric + * %% + * This program 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 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ +/** + * Nuiton matrix viewer jfreechart renderer. + */ +package org.nuiton.math.matrix.viewer.renderer; Property changes on: trunk/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/renderer/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Modified: trunk/src/site/rst/index.rst =================================================================== --- trunk/src/site/rst/index.rst 2010-12-16 17:21:23 UTC (rev 318) +++ trunk/src/site/rst/index.rst 2010-12-17 09:38:15 UTC (rev 319) @@ -5,7 +5,7 @@ .. * $Id$ .. * $HeadURL$ .. * %% -.. * Copyright (C) 2004 - 2010 CodeLutin +.. * Copyright (C) 2004 - 2010 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU Lesser General Public License as @@ -31,9 +31,9 @@ Présentation ------------ -NuitonMatrix est une librairie, pour la manipulation de matrice à n dimension. +NuitonMatrix est une librairie, pour la manipulation de matrice à n dimensions. Elle contient les fonctions mathématiques classiques sur les matrices, somme, -multiplication, ... +multiplication, produit scalaire, produit matriciel... Cette librairie dispose de plus un ensemble de composants pour faciliter son intégration dans les interfaces graphiques de type swing. @@ -49,5 +49,6 @@ - itération sur les matrices - import/export CSV - composants graphiques + - génération automatique de graphique basé sur JFreeChart **Veuillez consulter la JavaDoc pour de plus ample détails.**