### from (start index) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.html Returns an iterable that iterates over all elements starting from the specified index. ```APIDOC ## from (start index) ### Description Iterates over all elements, starting from the indicated element. ### Method public LargeDoubleArray.FromIterable from(long from) ### Parameters #### Path Parameters - **from** (long) - Required - From index, inclusive ### Returns Iterable ``` -------------------------------- ### from Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.html Creates an iterable that starts iterating from a specified element index. ```APIDOC ## from ### Description Iterates over all elements, starting from the indicated element. ### Method public LargeIntArray.FromIterable from(long from) ### Parameters #### Path Parameters - **from** (long) - Required - From index, inclusive ### Returns Iterable ``` -------------------------------- ### from Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.html Creates an iterable that iterates over all elements starting from a specified element. ```APIDOC ## from ### Description Iterates over all elements, starting from the indicated element. ### Parameters * **from** (long) - The starting element index for iteration. ### Returns * A `LargeLongArray.FromIterable` instance. ``` -------------------------------- ### GradientDescentVOSLayoutAlgorithm Configuration Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/GradientDescentVOSLayoutAlgorithm.html Methods for configuring the Gradient Descent VOS Layout Algorithm, including setting and getting iteration limits, step sizes, and quality improvement thresholds. ```APIDOC ## getMaxNIterations ### Description Returns the maximum number of iterations. ### Method GET ### Endpoint /GradientDescentVOSLayoutAlgorithm/maxNIterations ### Response #### Success Response (200) - **Maximum number of iterations** (int) - Description of the maximum number of iterations. ## getInitialStepSize ### Description Returns the initial step size. ### Method GET ### Endpoint /GradientDescentVOSLayoutAlgorithm/initialStepSize ### Response #### Success Response (200) - **Initial step size** (double) - Description of the initial step size. ## getMinStepSize ### Description Returns the minimum step size. ### Method GET ### Endpoint /GradientDescentVOSLayoutAlgorithm/minStepSize ### Response #### Success Response (200) - **Minimum step size** (double) - Description of the minimum step size. ## getStepSizeReduction ### Description Returns the step size reduction. ### Method GET ### Endpoint /GradientDescentVOSLayoutAlgorithm/stepSizeReduction ### Response #### Success Response (200) - **Step size reduction** (double) - Description of the step size reduction. ## getRequiredNQualityValueImprovements ### Description Returns the required number of quality value improvements. ### Method GET ### Endpoint /GradientDescentVOSLayoutAlgorithm/requiredNQualityValueImprovements ### Response #### Success Response (200) - **Required number of quality value improvements** (int) - Description of the required number of quality value improvements. ## setMaxNIterations ### Description Sets the maximum number of iterations. ### Method POST ### Endpoint /GradientDescentVOSLayoutAlgorithm/maxNIterations ### Parameters #### Request Body - **maxNIterations** (int) - Required - Maximum number of iterations ## setInitialStepSize ### Description Sets the initial step size. ### Method POST ### Endpoint /GradientDescentVOSLayoutAlgorithm/initialStepSize ### Parameters #### Request Body - **initialStepSize** (double) - Required - Initial step size ## setMinStepSize ### Description Sets the minimum step size. ### Method POST ### Endpoint /GradientDescentVOSLayoutAlgorithm/minStepSize ### Parameters #### Request Body - **minStepSize** (double) - Required - Minimum step size ## setStepSizeReduction ### Description Sets the step size reduction. ### Method POST ### Endpoint /GradientDescentVOSLayoutAlgorithm/stepSizeReduction ### Parameters #### Request Body - **stepSizeReduction** (double) - Required - Step size reduction ## setRequiredNQualityValueImprovements ### Description Sets the required number of quality value improvements. ### Method POST ### Endpoint /GradientDescentVOSLayoutAlgorithm/requiredNQualityValueImprovements ### Parameters #### Request Body - **requiredNQualityValueImprovements** (int) - Required - Required number of quality value improvements ``` -------------------------------- ### from(from) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.html Returns an iterable view of the array starting from the specified index. This allows for iteration over a sub-range of the array. ```APIDOC ## from(from) ### Description Iterates over all elements, starting from the indicated element. ### Method public LargeLongArray.FromIterable from(long from) ### Parameters #### Path Parameters - **from** (long) - Required - From index, inclusive ### Returns Iterable ``` -------------------------------- ### from Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.html Creates an iterable view of the array starting from the specified index. This allows iterating over elements from a certain point onwards. ```APIDOC ## from ### Description Iterates over all elements, starting from the indicated element. ### Method `[LargeIntArray.FromIterable](../../../nl/cwts/util/LargeIntArray.FromIterable.html)` ### Parameters #### Path Parameters - **from** (long) - Description: The starting index for iteration. ``` -------------------------------- ### VOSLayoutAlgorithm Constructor with Parameters Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/VOSLayoutAlgorithm.html Constructs a VOS layout algorithm with specified attraction, repulsion, and edge weight increment parameters. ```APIDOC ## VOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement) ### Description Constructs a VOS layout algorithm with a specified attraction parameter, repulsion parameter, and edge weight increment parameter. ### Method `VOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement)` ### Parameters #### Path Parameters - **attraction** (int) - Required - Attraction parameter. - **repulsion** (int) - Required - Repulsion parameter. - **edgeWeightIncrement** (double) - Required - Edge weight increment parameter. ``` -------------------------------- ### Run Network Layout Tool Source: https://github.com/cwtsleiden/networkanalysis/blob/master/README.md Executes the RunNetworkLayout tool with default parameters. Requires a network edge list file as input and outputs node coordinates for visualization. ```bash java -cp networkanalysis-1.3.0.jar nl.cwts.networkanalysis.run.RunNetworkLayout -o layout.txt network.txt ``` -------------------------------- ### get(long index) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.html Gets value element based on long index. ```APIDOC ## get ### Description Gets value element based on long index. ### Parameters #### Path Parameters - **index** (Index) - Description: Index of element ### Returns - **Value** - Description: Value of element ``` -------------------------------- ### Run Network Layout Tool (Compiled JAR) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/README.md Executes the RunNetworkLayout tool using a compiled JAR file. Replace with the actual version number. ```bash java -cp build/libs/networkanalysis-.jar nl.cwts.networkanalysis.run.RunNetworkLayout ``` -------------------------------- ### get(int segment, int offset) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.html Gets value element based on segment and offset. ```APIDOC ## get ### Description Gets value element based on segment and offset. ### Parameters #### Path Parameters - **segment** (Segment) - Description: Segment of element - **offset** (Offset) - Description: Offset of element ### Returns - **Value** - Description: Value of element ``` -------------------------------- ### Constructor Summary Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/GradientDescentVOSLayoutAlgorithm.html Provides a summary of the constructors available for the GradientDescentVOSLayoutAlgorithm. ```APIDOC ## Constructor Summary ### `GradientDescentVOSLayoutAlgorithm()` Constructs a gradient descent VOS layout algorithm. ### `GradientDescentVOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement, int maxNIterations, double initialStepSize, double minStepSize, double stepSizeReduction, int requiredNQualityValueImprovements, java.util.Random random)` Constructs a gradient descent VOS layout algorithm for a specified attraction parameter, repulsion parameter, edge weight increment parameter, maximum number of iterations, initial step size, minimum step size, step size reduction, and required number of quality value improvements. ### `GradientDescentVOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement, java.util.Random random)` Constructs a gradient descent VOS layout algorithm for a specified attraction parameter, repulsion parameter, and edge weight increment parameter. ### `GradientDescentVOSLayoutAlgorithm(java.util.Random random)` Constructs a gradient descent VOS layout algorithm. ``` -------------------------------- ### updateFrom Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.html Updates this array from the provided array. Values from the other array starting at `from` until `to` (exclusive) will be copied to this array, starting from the `insertionPoint` onwards. ```APIDOC ## updateFrom ### Description Updates this array from the provided array. Values from other array starting at `from` until `to` (exclusive) will be copied to this array, starting from the `insertionPoint` onwards. ### Parameters #### Path Parameters - **array** (LargeDoubleArray) - The array to update from. - **from** (long) - Index in `array` from where to update, inclusive. - **to** (long) - Index in `array` until where to update, exclusive. - **insertionPoint** (long) - Starting index in this array to update. ``` -------------------------------- ### LouvainAlgorithm Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/LouvainAlgorithm.html Provides documentation for the various constructors of the LouvainAlgorithm class, allowing for different initialization configurations. ```APIDOC ## LouvainAlgorithm() ### Description Constructs a Louvain algorithm. ### Method Constructor ## LouvainAlgorithm(Random random) ### Description Constructs a Louvain algorithm. ### Method Constructor ### Parameters #### Path Parameters - **random** (Random) - Random number generator ## LouvainAlgorithm(double resolution, int nIterations, Random random) ### Description Constructs a Louvain algorithm for a specified resolution parameter and number of iterations. ### Method Constructor ### Parameters #### Path Parameters - **resolution** (double) - Resolution parameter - **nIterations** (int) - Number of iterations - **random** (Random) - Random number generator ## LouvainAlgorithm(double resolution, int nIterations, IncrementalCPMClusteringAlgorithm localMovingAlgorithm) ### Description Constructs a Louvain algorithm for a specified resolution parameter, number of iterations, and local moving algorithm. ### Method Constructor ### Parameters #### Path Parameters - **resolution** (double) - Resolution parameter - **nIterations** (int) - Number of iterations - **localMovingAlgorithm** (IncrementalCPMClusteringAlgorithm) - Local moving algorithm ``` -------------------------------- ### getSegment Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.html Gets the segment of the index. ```APIDOC ## getSegment ### Description Gets the segment of the index. ### Parameters #### Path Parameters - **index** (Index) - Description: Index ### Returns - **Segment** - Description: Segment ``` -------------------------------- ### size() in LargeLongArray Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the size of a LargeLongArray. ```APIDOC ## size() in LargeLongArray ### Description Gets the size of a LargeLongArray. ### Method Method call ### Response #### Success Response (200) - **size** (int) - The number of elements in the array. ``` -------------------------------- ### VOSLayoutAlgorithm Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/VOSLayoutAlgorithm.html Provides documentation for the constructors of the VOSLayoutAlgorithm class. ```APIDOC ## VOSLayoutAlgorithm() ### Description Constructs a VOS layout algorithm. ### Constructor `public VOSLayoutAlgorithm()` ``` ```APIDOC ## VOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement) ### Description Constructs a VOS layout algorithm with a specified attraction parameter, repulsion parameter, and edge weight increment parameter. ### Constructor `public VOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement)` ### Parameters * **attraction** (int) - The attraction parameter. * **repulsion** (int) - The repulsion parameter. * **edgeWeightIncrement** (double) - The edge weight increment parameter. ``` -------------------------------- ### size() in LargeIntArray Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the size of a LargeIntArray. ```APIDOC ## size() in LargeIntArray ### Description Gets the size of a LargeIntArray. ### Method Method call ### Response #### Success Response (200) - **size** (int) - The number of elements in the array. ``` -------------------------------- ### VOSLayoutAlgorithm Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/VOSLayoutAlgorithm.html Constructs a VOS layout algorithm with default parameters. ```APIDOC ## VOSLayoutAlgorithm() ### Description Constructs a VOS layout algorithm. ### Method `VOSLayoutAlgorithm()` ``` -------------------------------- ### capacity Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.html Gets the current capacity of the array. ```APIDOC ## `long capacity()` ### Description Gets the current capacity of the array. ### Method `long` ### Returns The capacity of the array. ``` -------------------------------- ### Instance Methods Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Network.html Methods available on an instance of the Network class. ```APIDOC ## Instance Methods ### checkIntegrity() Checks the integrity of the network. ### createNetworkWithoutEdgeWeights() Creates a copy of the network, but without edge weights. ### createNetworkWithoutNodeAndEdgeWeights() Creates a copy of the network, but without node and edge weights. ### createNetworkWithoutNodeWeights() Creates a copy of the network, but without node weights. ``` -------------------------------- ### length Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeBooleanArray.html Gets the length of a specific segment. ```APIDOC ## length(segment) ### Description Gets the length of the indicated segment. ### Parameters #### Path Parameters - **segment** (int) - Segment ### Returns - **Length of segment** (int) ``` -------------------------------- ### Method Summary Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/GradientDescentVOSLayoutAlgorithm.html Provides a summary of the instance methods available for the GradientDescentVOSLayoutAlgorithm. ```APIDOC ## Method Summary ### `clone()` Clones the algorithm. ### `findLayout(Network network)` Finds a layout using the gradient descent VOS layout algorithm. ### `getInitialStepSize()` Returns the initial step size. ### `getMaxNIterations()` Returns the maximum number of iterations. ### `getMinStepSize()` Returns the minimum step size. ### `getRequiredNQualityValueImprovements()` Returns the required number of quality value improvements. ``` -------------------------------- ### Run Network Layout Tool Source: https://github.com/cwtsleiden/networkanalysis/blob/master/README.md Execute the RunNetworkLayout tool to determine a network layout using the gradient descent VOS algorithm. Specify the JAR file and the main class. Options include quality function, normalization, attraction, repulsion, and iteration parameters. ```bash java -cp networkanalysis-1.3.0.jar nl.cwts.networkanalysis.run.RunNetworkLayout ``` ```text RunNetworkLayout version 1.3.0 By Nees Jan van Eck and Ludo Waltman Centre for Science and Technology Studies (CWTS), Leiden University Usage: RunNetworkLayout [options] Determine a layout for a network using the gradient descent VOS layout algorithm. The file in is expected to contain a tab-separated edge list (without a header line). Nodes are represented by zero-index integer numbers. Only undirected networks are supported. Each edge should be included only once in the file. Options: -q --quality-function {VOS|LinLog} (default: VOS) Quality function to be optimized. Either the VOS (visualization of similarities) or the LinLog quality function can be used. -n --normalization {none|AssociationStrength|Fractionalization} (Default: none) Method for normalizing edge weights in the VOS quality function. -a --attraction (Default: 2) Attraction parameter of the VOS quality function. -r --repulsion (default: 1) Repulsion parameter of the VOS quality function. -s --random-starts (default: 1) Number of random starts of the gradient descent algorithm. -i --max-iterations (default: 1000) Maximum number of iterations of the gradient descent algorithm. --initial-step-size (default: 1.0) Initial step size of the gradient descent algorithm. ``` -------------------------------- ### LargeLongArray.iterator Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Method to get an iterator for all elements of a LargeLongArray. ```APIDOC ## LargeLongArray.iterator ### Description Method to get an iterator for all elements of a LargeLongArray. ### Method `iterator()` Iterates over all elements. ``` -------------------------------- ### load Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Layout.html Loads a layout from a file. ```APIDOC ## load ### Description Loads a layout from a file. ### Method `public static Layout load(String fileName)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters * **fileName** (String) - Required - File from which a layout is loaded ### Returns * **Layout** - Loaded layout ### Throws * `java.lang.ClassNotFoundException` - Class not found * `java.io.IOException` - Could not read the file ### See Also * `save(String fileName)` ``` -------------------------------- ### LargeIntArray.iterator Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Method to get an iterator for all elements of a LargeIntArray. ```APIDOC ## LargeIntArray.iterator ### Description Method to get an iterator for all elements of a LargeIntArray. ### Method `iterator()` Iterates over all elements. ``` -------------------------------- ### LouvainAlgorithm Methods Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/LouvainAlgorithm.html Details the methods available for the LouvainAlgorithm, including cloning, retrieving the local moving algorithm, and setting the resolution. ```APIDOC ## clone() ### Description Clones the algorithm. ### Method public LouvainAlgorithm clone() ### Returns #### Success Response - **LouvainAlgorithm** - Cloned algorithm ## getLocalMovingAlgorithm() ### Description Returns the local moving algorithm. ### Method public IncrementalCPMClusteringAlgorithm getLocalMovingAlgorithm() ### Returns #### Success Response - **IncrementalCPMClusteringAlgorithm** - Local moving algorithm ## setResolution(double resolution) ### Description Sets the resolution parameter. Also sets the resolution parameter for the local moving algorithm. ### Method public void setResolution(double resolution) ### Parameters #### Path Parameters - **resolution** (double) - Resolution parameter ``` -------------------------------- ### GradientDescentVOSLayoutAlgorithm Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/GradientDescentVOSLayoutAlgorithm.html Provides documentation for the different constructors of the GradientDescentVOSLayoutAlgorithm class, allowing for flexible initialization with default or custom parameters. ```APIDOC ## GradientDescentVOSLayoutAlgorithm() ### Description Constructs a gradient descent VOS layout algorithm with default parameters. ### Constructor `public GradientDescentVOSLayoutAlgorithm()` ## GradientDescentVOSLayoutAlgorithm(Random random) ### Description Constructs a gradient descent VOS layout algorithm with a specified random number generator. ### Constructor `public GradientDescentVOSLayoutAlgorithm(Random random)` ### Parameters * **random** (Random) - Required - Random number generator. ## GradientDescentVOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement, Random random) ### Description Constructs a gradient descent VOS layout algorithm for a specified attraction parameter, repulsion parameter, and edge weight increment parameter, along with a random number generator. ### Constructor `public GradientDescentVOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement, Random random)` ### Parameters * **attraction** (int) - Required - Attraction parameter. * **repulsion** (int) - Required - Repulsion parameter. * **edgeWeightIncrement** (double) - Required - Edge weight increment parameter. * **random** (Random) - Required - Random number generator. ## GradientDescentVOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement, int maxNIterations, double initialStepSize, double minStepSize, double stepSizeReduction, int requiredNQualityValueImprovements, Random random) ### Description Constructs a gradient descent VOS layout algorithm with a comprehensive set of parameters, including attraction, repulsion, edge weight increment, iteration limits, step size controls, quality improvement requirements, and a random number generator. ### Constructor `public GradientDescentVOSLayoutAlgorithm(int attraction, int repulsion, double edgeWeightIncrement, int maxNIterations, double initialStepSize, double minStepSize, double stepSizeReduction, int requiredNQualityValueImprovements, Random random)` ### Parameters * **attraction** (int) - Required - Attraction parameter. * **repulsion** (int) - Required - Repulsion parameter. * **edgeWeightIncrement** (double) - Required - Edge weight increment parameter. * **maxNIterations** (int) - Required - Maximum number of iterations. * **initialStepSize** (double) - Required - Initial step size. * **minStepSize** (double) - Required - Minimum step size. * **stepSizeReduction** (double) - Required - Step size reduction. * **requiredNQualityValueImprovements** (int) - Required - Required number of quality value improvements. * **random** (Random) - Required - Random number generator. ``` -------------------------------- ### LouvainAlgorithm() Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/LouvainAlgorithm.html Constructs a Louvain algorithm with default parameters. ```APIDOC ## LouvainAlgorithm() ### Description Constructs a Louvain algorithm. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **LouvainAlgorithm** - An instance of the Louvain algorithm. ``` -------------------------------- ### LargeLongArray.FromIterable.iterator Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Method to get an iterator for a LargeLongArray created from an iterable. ```APIDOC ## LargeLongArray.FromIterable.iterator ### Description Method to get an iterator for a LargeLongArray created from an iterable. ### Method `iterator()` Returns an iterator for the array. ``` -------------------------------- ### Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.html Provides details on how to initialize a LargeDoubleArray. ```APIDOC ## Constructors ### `LargeDoubleArray(double[] values)` Constructs a new array copying the values of the supplied array. ### `LargeDoubleArray(long size)` Constructs a new empty array of specified size. ### `LargeDoubleArray(long size, double constant)` Constructs a new array of indicated size with all elements set to a constant value. ``` -------------------------------- ### getSegment(long) - LargeLongArray Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the segment of the index for a LargeLongArray. ```APIDOC ## getSegment(long) ### Description Gets the segment of the index. ### Method Static method ### Class nl.cwts.util.LargeLongArray ``` -------------------------------- ### getSegment(long) - LargeIntArray Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the segment of the index for a LargeIntArray. ```APIDOC ## getSegment(long) ### Description Gets the segment of the index. ### Method Static method ### Class nl.cwts.util.LargeIntArray ``` -------------------------------- ### getSegment(long) - LargeDoubleArray Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the segment of the index for a LargeDoubleArray. ```APIDOC ## getSegment(long) ### Description Gets the segment of the index. ### Method Static method ### Class nl.cwts.util.LargeDoubleArray ``` -------------------------------- ### load Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Network.html Loads a network from a specified file. ```APIDOC ## load ### Description Loads a network from a file. ### Method POST (assumed, as it modifies state) ### Endpoint /network/load ### Parameters #### Request Body - **filename** (string) - Required - The name of the file to load the network from. ``` -------------------------------- ### getSegment(long) - LargeBooleanArray Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the segment of the index for a LargeBooleanArray. ```APIDOC ## getSegment(long) ### Description Gets the segment of the index. ### Method Static method ### Class nl.cwts.util.LargeBooleanArray ``` -------------------------------- ### ComponentsAlgorithm Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/ComponentsAlgorithm.html Constructs a new ComponentsAlgorithm instance. ```APIDOC ## ComponentsAlgorithm() ### Description Constructs a components algorithm. ### Constructor `ComponentsAlgorithm()` ``` -------------------------------- ### clone() Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/LouvainAlgorithm.html Creates a copy of the current Louvain algorithm instance. ```APIDOC ## clone() ### Description Clones the algorithm, creating a deep copy of the current Louvain algorithm instance. ### Method Instance Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **LouvainAlgorithm** - A new instance of the Louvain algorithm that is a clone of the original. ``` -------------------------------- ### LargeLongArray.FromToIterable.iterator Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Method to get an iterator for a LargeLongArray created from a range iterable. ```APIDOC ## LargeLongArray.FromToIterable.iterator ### Description Method to get an iterator for a LargeLongArray created from a range iterable. ### Method `iterator()` Returns an iterator for the array. ``` -------------------------------- ### LargeIntArray.FromToIterable.iterator Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Method to get an iterator for a LargeIntArray created from a range iterable. ```APIDOC ## LargeIntArray.FromToIterable.iterator ### Description Method to get an iterator for a LargeIntArray created from a range iterable. ### Method `iterator()` Returns an iterator for the array. ``` -------------------------------- ### Compile Network Analysis Package (Windows) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/README.md Compiles the networkanalysis package source code on Windows using Gradle Wrapper. ```bash gradlew build ``` -------------------------------- ### Clustering Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Clustering.html Provides information on how to create Clustering objects. ```APIDOC ## Clustering(int nNodes) ### Description Constructs a singleton clustering for a specified number of nodes. ### Constructor `Clustering(int nNodes)` ### Parameters * **nNodes** (int) - The number of nodes in the network. ``` ```APIDOC ## Clustering(int[] clusters) ### Description Constructs a clustering using a specified cluster for each node. ### Constructor `Clustering(int[] clusters)` ### Parameters * **clusters** (int[]) - An array where each element represents the cluster assignment for a node. ``` -------------------------------- ### capacity() - LargeBooleanArray Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the capacity of the LargeBooleanArray. This is a method of the LargeBooleanArray class. ```APIDOC ## capacity() ### Description Gets capacity of the array. ### Method (Not specified, likely a class method) ### Endpoint (Not applicable, this is a Java method) ### Parameters (None) ### Response (Not specified) ``` -------------------------------- ### get (by index) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.html Retrieves the value of an element using its overall index. ```APIDOC ## get (by index) ### Description Gets value element based on long index. ### Method public long get(long index) ### Parameters #### Path Parameters - **index** (long) - Index of element ### Returns - **Value of element** (long) - Value of element ``` -------------------------------- ### LouvainAlgorithm(double resolution, int nIterations, IncrementalCPMClusteringAlgorithm localMovingAlgorithm) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/LouvainAlgorithm.html Constructs a Louvain algorithm with a specified resolution, number of iterations, and local moving algorithm. ```APIDOC ## LouvainAlgorithm(double resolution, int nIterations, IncrementalCPMClusteringAlgorithm localMovingAlgorithm) ### Description Constructs a Louvain algorithm for a specified resolution parameter, number of iterations, and local moving algorithm. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **LouvainAlgorithm** - An instance of the Louvain algorithm configured with the provided parameters. ``` -------------------------------- ### get (index) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.html Retrieves an element using its overall long index. ```APIDOC ## get (index) ### Description Gets value element based on long index. ### Parameters * **index** (long) - The overall index of the element. ### Returns * The long value at the specified index. ``` -------------------------------- ### LeidenAlgorithm Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/LeidenAlgorithm.html Provides details on how to construct a LeidenAlgorithm object with various parameters. ```APIDOC ## LeidenAlgorithm() ### Description Constructs a Leiden algorithm. ### Method Constructor ## LeidenAlgorithm(Random random) ### Description Constructs a Leiden algorithm. ### Method Constructor ### Parameters #### Path Parameters - **random** (Random) - Required - Random number generator ## LeidenAlgorithm(double resolution, int nIterations, double randomness, Random random) ### Description Constructs a Leiden algorithm for a specified resolution parameter, number of iterations, and randomness parameter. ### Method Constructor ### Parameters #### Path Parameters - **resolution** (double) - Required - Resolution parameter - **nIterations** (int) - Required - Number of iterations - **randomness** (double) - Required - Randomness parameter - **random** (Random) - Required - Random number generator ## LeidenAlgorithm(double resolution, int nIterations, double randomness, IncrementalCPMClusteringAlgorithm localMovingAlgorithm, Random random) ### Description Constructs a Leiden algorithm for a specified resolution parameter, number of iterations, randomness parameter, and local moving algorithm. ### Method Constructor ### Parameters #### Path Parameters - **resolution** (double) - Required - Resolution parameter - **nIterations** (int) - Required - Number of iterations - **randomness** (double) - Required - Randomness parameter - **localMovingAlgorithm** (IncrementalCPMClusteringAlgorithm) - Required - Local moving algorithm - **random** (Random) - Required - Random number generator ``` -------------------------------- ### get(long index) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeBooleanArray.html Retrieves the boolean value at a specified long index. ```APIDOC ## get(index) ### Description Gets value element based on long index. ### Parameters #### Path Parameters - **index** (long) - Index of element ### Returns - **Value of element** (boolean) ``` -------------------------------- ### GradientDescentVOSLayoutAlgorithm(int, int, double, int, double, double, double, int, Random) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Constructs a gradient descent VOS layout algorithm with detailed parameters for attraction, repulsion, edge weight increment, iterations, step size, and quality improvements. ```APIDOC ## GradientDescentVOSLayoutAlgorithm(int, int, double, int, double, double, double, int, Random) ### Description Constructs a gradient descent VOS layout algorithm for a specified attraction parameter, repulsion parameter, edge weight increment parameter, maximum number of iterations, initial step size, minimum step size, step size reduction, and required number of quality value improvements. ### Method Constructor ### Class nl.cwts.networkanalysis.GradientDescentVOSLayoutAlgorithm ``` -------------------------------- ### LargeLongArray.FromIterable Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.FromIterable.html Constructs a new LargeLongArray.FromIterable instance that starts from the specified long value. ```APIDOC ## FromIterable(long from) ### Description Constructs a new LargeLongArray.FromIterable instance that starts from the specified long value. ### Parameters #### Path Parameters - **from** (long) - The starting long value for the iterable sequence. ``` -------------------------------- ### StandardLocalMovingAlgorithm Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/StandardLocalMovingAlgorithm.html Constructors for the StandardLocalMovingAlgorithm class. ```APIDOC ## StandardLocalMovingAlgorithm() ### Description Constructs a standard local moving algorithm. ### Constructor `StandardLocalMovingAlgorithm()` ## StandardLocalMovingAlgorithm(double resolution, Random random) ### Description Constructs a standard local moving algorithm for a specified resolution parameter. ### Constructor `StandardLocalMovingAlgorithm(double resolution, java.util.Random random)` ``` -------------------------------- ### setInitialStepSize(double) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Sets the initial step size for the Gradient Descent VOS Layout Algorithm. ```APIDOC ## setInitialStepSize(double) ### Description Sets the initial step size. ### Method Not specified (likely a Java method call) ### Endpoint Not applicable (this appears to be a library method, not an HTTP endpoint) ### Parameters * **stepSize** (double) - The initial step size value. ``` -------------------------------- ### getOffset(long) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Gets the offset within a particular segment of the index for large arrays. ```APIDOC ## getOffset(long) ### Description Gets the offset within a particular segment of the index. ### Method Static method call ### Parameters #### Path Parameters - **index** (long) - Required - The index value. ``` -------------------------------- ### capacity Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.html Gets the current capacity of the array. The capacity is always greater than or equal to the size. ```APIDOC ## capacity() ### Description Gets capacity of array. ### Returns - **long** - Capacity ``` -------------------------------- ### GradientDescentVOSLayoutAlgorithm() Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/index-all.html Constructs a gradient descent VOS layout algorithm. ```APIDOC ## GradientDescentVOSLayoutAlgorithm() ### Description Constructs a gradient descent VOS layout algorithm. ### Method Constructor ### Class nl.cwts.networkanalysis.GradientDescentVOSLayoutAlgorithm ``` -------------------------------- ### StandardLocalMovingAlgorithm Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/StandardLocalMovingAlgorithm.html Constructs a standard local moving algorithm. Multiple constructors are available to initialize the algorithm with or without a specific resolution parameter and random number generator. ```APIDOC ## Constructors ### StandardLocalMovingAlgorithm() Constructs a standard local moving algorithm. ### StandardLocalMovingAlgorithm(Random random) Constructs a standard local moving algorithm. **Parameters:** - **random** (Random) - Random number generator ### StandardLocalMovingAlgorithm(double resolution, Random random) Constructs a standard local moving algorithm for a specified resolution parameter. **Parameters:** - **resolution** (double) - Resolution parameter - **random** (Random) - Random number generator ``` -------------------------------- ### size Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.html Gets the current size of the array. The size is always less than or equal to the capacity. ```APIDOC ## size() ### Description Gets size of array. ### Returns - **long** - Size ``` -------------------------------- ### RunNetworkLayout Class Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/run/package-frame.html Manages the generation of network layouts. ```APIDOC ## RunNetworkLayout Class ### Description Manages the generation of network layouts. ### Methods (No specific methods are detailed in the provided source for direct user invocation.) ### Usage This class is used to generate visual layouts for network structures. ``` -------------------------------- ### get (segment, offset) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.html Retrieves an element using its segment and offset within that segment. ```APIDOC ## get (segment, offset) ### Description Gets value element based on segment and offset. ### Parameters * **segment** (int) - The segment index. * **offset** (int) - The offset within the segment. ### Returns * The long value at the specified segment and offset. ``` -------------------------------- ### from Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.html Creates an iterable view of the LargeDoubleArray starting from a specified index. This is useful for iterating over a portion of the array. ```APIDOC ## from ### Description Iterates over all elements, starting from the indicated element. ### Method Not specified (likely a static method or constructor). ### Parameters #### Path Parameters - **from** (long) - The starting index for iteration. ``` -------------------------------- ### Run Network Clustering Tool (Compiled JAR) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/README.md Executes the RunNetworkClustering tool using a compiled JAR file. Replace with the actual version number. ```bash java -cp build/libs/networkanalysis-.jar nl.cwts.networkanalysis.run.RunNetworkClustering ``` -------------------------------- ### LargeIntArray.FromIterable Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.FromIterable.html Constructs a new LargeIntArray.FromIterable instance that starts iterating from the specified long value. ```APIDOC ## Constructor: FromIterable ### Description Constructs a new `LargeIntArray.FromIterable` instance that starts iterating from the specified long value. ### Parameters #### Path Parameters - **from** (long) - The starting value for the iteration. ``` -------------------------------- ### Instance Methods Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.html Details the instance methods available for interacting with a LargeDoubleArray object. ```APIDOC ## Instance Methods ### `void add(long index, double addition)` Adds `addition` to the existing element at the specified `index`. ### `void append(double value)` Appends a specified `value` to the end of the array. ### `long binarySearch(double value)` Searches for the specified `value` using binary search within the entire array. ### `long binarySearch(long from, long to, double value)` Searches for the specified `value` using binary search within the indicated range [`from`, `to`). ### `double calcAverage()` Calculates the average of all elements in the array. ### `double calcMaximum()` Calculates the maximum value among all elements in the array. ### `double calcMinimum()` Calculates the minimum value among all elements in the array. ### `double calcSum()` Calculates the sum of all elements in the array. ### `double calcSum(long from, long to)` Calculates the sum of all elements within the indicated range [`from`, `to`). ### `long capacity()` Gets the current capacity of the array. ### `void clear()` Removes all elements from the array, resetting it to an empty state. ### `LargeDoubleArray clone()` Creates and returns a shallow copy (clone) of the array. ``` -------------------------------- ### Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeBooleanArray.html Provides information on how to create new LargeBooleanArray instances. ```APIDOC ## Constructors ### `LargeBooleanArray(boolean[] values)` **Description**: Constructs a new array by copying the values from the supplied boolean array. ### `LargeBooleanArray(long size)` **Description**: Constructs a new, empty array with the specified size. ### `LargeBooleanArray(long size, boolean constant)` **Description**: Constructs a new array of the indicated size, with all elements initialized to the specified constant boolean value. ``` -------------------------------- ### get(int segment, int offset) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeBooleanArray.html Retrieves the boolean value at a specified segment and offset. ```APIDOC ## get(segment, offset) ### Description Gets value element based on segment and offset. ### Parameters #### Path Parameters - **segment** (int) - Segment of element - **offset** (int) - Offset of element ### Returns - **Value of element** (boolean) ``` -------------------------------- ### removeEmptyClustersLargerThan Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Clustering.html Removes empty clusters and relabels clusters consecutively, starting from a specified minimum cluster number. ```APIDOC ## removeEmptyClustersLargerThan ### Description Removes empty clusters and relabels clusters to follow consecutive numbering only for clusters larger than the specified minimum number of clusters. Each empty cluster larger that `minimumCluster` is reassigned to the lowest available cluster, in the order of the existing clusters. For example, if `minimumCluster = 5` and cluster 2 and 7 are empty, then cluster 8 is relabeled to 7 (and 9 to 8, etc...), but clusters 0-4 remain as they are. ### Method public void removeEmptyClustersLargerThan(int minimumCluster) ### Parameters #### Path Parameters - **minimumCluster** (int) - Required - Minimum cluster to start relabeling from ``` -------------------------------- ### LargeDoubleArray.FromIterable Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.FromIterable.html Represents an iterable view of a LargeDoubleArray starting from a specified index. It implements the Iterable interface. ```APIDOC ## Class LargeDoubleArray.FromIterable * java.lang.Object * * nl.cwts.util.LargeDoubleArray.FromIterable * All Implemented Interfaces: java.lang.Iterable Enclosing class: [LargeDoubleArray](../../../nl/cwts/util/LargeDoubleArray.html "class in nl.cwts.util") * * * public class LargeDoubleArray.FromIterable extends java.lang.Object implements java.lang.Iterable Iterable starting from a certain element. * * ### Constructor Summary Constructors  Constructor and Description `[FromIterable](../../../nl/cwts/util/LargeDoubleArray.FromIterable.html#FromIterable-long-)(long from)` * * ### Method Summary All Methods [Instance Methods](javascript:show(2);) [Concrete Methods](javascript:show(8);)  Modifier and Type Method and Description `java.util.Iterator` `[iterator](../../../nl/cwts/util/LargeDoubleArray.FromIterable.html#iterator--)()` * * ### Constructor Detail * #### FromIterable public FromIterable(long from) * * ### Method Detail * #### iterator public java.util.Iterator iterator() Specified by: `iterator` in interface `java.lang.Iterable` ``` -------------------------------- ### save Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Layout.html Saves the layout in a file. ```APIDOC ## save ### Description Saves the layout in a file. ### Method `public void save(String fileName)` ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters * **fileName** (String) - Required - File in which the layout is saved ### Throws * `java.io.IOException` - Could not write to the file ### See Also * `load(String fileName)` ``` -------------------------------- ### LargeDoubleArray.FromToIterable Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.FromToIterable.html Constructs a new FromToIterable instance specifying the start and end indices (inclusive) of the range. ```APIDOC ## FromToIterable(long from, long to) ### Description Constructs a new `FromToIterable` instance specifying the start and end indices (inclusive) of the range. ### Parameters * **from** (long) - The starting index of the range. * **to** (long) - The ending index of the range. ``` -------------------------------- ### FastLocalMovingAlgorithm Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/FastLocalMovingAlgorithm.html Constructs a fast local moving algorithm for a specified resolution parameter and number of iterations. ```APIDOC ## FastLocalMovingAlgorithm Constructor ### Description Constructs a fast local moving algorithm for a specified resolution parameter and number of iterations. ### Parameters #### Path Parameters - **resolution** (double) - Required - Resolution parameter - **nIterations** (int) - Required - Number of iterations - **random** (java.util.Random) - Required - Random number generator ``` -------------------------------- ### size Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeBooleanArray.html Gets the current size of the LargeBooleanArray. The size represents the number of elements currently stored in the array. ```APIDOC ## size ### Description Gets the current size of the LargeBooleanArray. ### Method long ### Endpoint size() ``` -------------------------------- ### FastLocalMovingAlgorithm Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/FastLocalMovingAlgorithm.html Constructs a fast local moving algorithm with specified resolution, iterations, and random number generator. ```java public FastLocalMovingAlgorithm(double resolution, int nIterations, java.util.Random random) ``` -------------------------------- ### initRandomCoordinates Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Layout.html Initializes a random layout. ```APIDOC ## initRandomCoordinates ### Description Initializes a random layout. ### Methods #### `initRandomCoordinates()` Initializes a random layout. #### `initRandomCoordinates(java.util.Random random)` Initializes a random layout with a specified random number generator. * **Parameters**: * `random` (java.util.Random) - Required - The random number generator to use. ``` -------------------------------- ### LargeLongArray.FromToIterable Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeLongArray.FromToIterable.html Constructs a new FromToIterable instance that iterates from a specified start value to a specified end value. ```APIDOC ## FromToIterable(long from, long to) ### Description Constructs a new FromToIterable instance that iterates from a specified start value to a specified end value. ### Parameters * **from** (long) - The starting value of the iterable range. * **to** (long) - The ending value of the iterable range. ``` -------------------------------- ### nSegments Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.html Gets the total number of segments currently used by the LargeDoubleArray. This provides information about the internal structure of the array. ```APIDOC ## nSegments ### Description Gets the number of segments. ### Method Not specified (likely a method call on a LargeDoubleArray instance). ### Response #### Success Response - Returns the number of segments as an integer. ``` -------------------------------- ### Network Constructors Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/Network.html Several constructors are available to create a Network object based on different input formats for nodes, edges, and weights. ```APIDOC ## Network Constructors ### Network(double[] nodeWeights, LargeIntArray[] edges, boolean sortedEdges, boolean checkIntegrity) Constructs a network based on a list of edges. ### Network(double[] nodeWeights, LargeIntArray[] edges, LargeDoubleArray edgeWeights, boolean sortedEdges, boolean checkIntegrity) Constructs a network based on a list of edges. ### Network(double[] nodeWeights, long[] firstNeighborIndices, LargeIntArray neighbors, boolean checkIntegrity) Constructs a network based on a list of neighbors. ### Network(double[] nodeWeights, long[] firstNeighborIndices, LargeIntArray neighbors, LargeDoubleArray edgeWeights, boolean checkIntegrity) Constructs a network based on a list of neighbors. ### Network(int nNodes, boolean setNodeWeightsToTotalEdgeWeights, LargeIntArray[] edges, boolean sortedEdges, boolean checkIntegrity) Constructs a network based on a list of edges. ### Network(int nNodes, boolean setNodeWeightsToTotalEdgeWeights, LargeIntArray[] edges, LargeDoubleArray edgeWeights, boolean sortedEdges, boolean checkIntegrity) Constructs a network based on a list of edges. ### Network(int nNodes, boolean setNodeWeightsToTotalEdgeWeights, long[] firstNeighborIndices, LargeIntArray neighbors, boolean checkIntegrity) Constructs a network based on a list of neighbors. ### Network(int nNodes, boolean setNodeWeightsToTotalEdgeWeights, long[] firstNeighborIndices, LargeIntArray neighbors, LargeDoubleArray edgeWeights, boolean checkIntegrity) Constructs a network based on a list of neighbors. ``` -------------------------------- ### calcSum(long from, long to) Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeDoubleArray.html Calculates and returns the sum of elements within a specified range (inclusive start, exclusive end). ```APIDOC ## calcSum(long from, long to) ### Description Calculates the sum of all elements in the indicated range. ### Method public double calcSum(long from, long to) ### Parameters #### Path Parameters * **from** (long) - From index, inclusive * **to** (long) - To index, exclusive ### Returns * **Sum** (double) ``` -------------------------------- ### clone Method Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/networkanalysis/GradientDescentVOSLayoutAlgorithm.html Provides documentation for the clone method, which creates a copy of the current GradientDescentVOSLayoutAlgorithm instance. ```APIDOC ## clone() ### Description Clones the algorithm, creating a new instance with the same configuration. ### Method `public GradientDescentVOSLayoutAlgorithm clone()` ### Returns A new `GradientDescentVOSLayoutAlgorithm` instance that is a copy of the current one. ``` -------------------------------- ### Constructor Source: https://github.com/cwtsleiden/networkanalysis/blob/master/docs/nl/cwts/util/LargeIntArray.FromToIterable.html Initializes a new instance of the LargeIntArray.FromToIterable class. ```APIDOC ## FromToIterable(long from, long to) ### Description Constructs an iterable range of integers starting from `from` and ending at `to`. ### Parameters * **from** (long) - The starting value of the range. * **to** (long) - The ending value of the range. ```