CosineProc (alpha-proc 2.0.0-alpha03 API)

java.lang.Object
- org.neo4j.gds.BaseProc
- - org.neo4j.gds.AlgoBaseProc<ALGO,org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,CONFIG,PROC_RESULT>
  - - org.neo4j.gds.similarity.AlphaSimilarityProc<org.neo4j.gds.impl.similarity.CosineAlgorithm,org.neo4j.gds.impl.similarity.CosineConfig,PROC_RESULT>
    - - org.neo4j.gds.similarity.cosine.CosineProc<PROC_RESULT>

All Implemented Interfaces:

org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.impl.similarity.CosineAlgorithm,org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,org.neo4j.gds.impl.similarity.CosineConfig,java.util.stream.Stream<PROC_RESULT>,org.neo4j.gds.AlgorithmFactory<?,org.neo4j.gds.impl.similarity.CosineAlgorithm,org.neo4j.gds.impl.similarity.CosineConfig>>

Direct Known Subclasses:

CosineStatsProc, CosineStreamProc, CosineWriteProc
```
public abstract class CosineProc<PROC_RESULT>
extends AlphaSimilarityProc<org.neo4j.gds.impl.similarity.CosineAlgorithm,org.neo4j.gds.impl.similarity.CosineConfig,PROC_RESULT>
```

Field Summary

Fields
Modifier and Type Field Description

protected static java.lang.String DESCRIPTION
- Fields inherited from class org.neo4j.gds.similarity.AlphaSimilarityProc
  SIMILARITY_FAKE_GRAPH_NAME
- Fields inherited from class org.neo4j.gds.AlgoBaseProc
  STATS_DESCRIPTION
- Fields inherited from class org.neo4j.gds.BaseProc
  allocationTracker, api, callContext, ESTIMATE_DESCRIPTION, log, procedureTransaction, taskRegistryFactory, transaction, userLogRegistryFactory, username

Constructor Summary

Constructors
Constructor Description

CosineProc()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected org.neo4j.gds.impl.similarity.CosineAlgorithm`	`newAlgo(org.neo4j.gds.impl.similarity.CosineConfig config, org.neo4j.gds.core.utils.mem.AllocationTracker allocationTracker)`
`protected org.neo4j.gds.impl.similarity.CosineConfig`	`newConfig(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper userInput)`
`protected java.lang.String`	`taskName()`

Methods inherited from class org.neo4j.gds.similarity.AlphaSimilarityProc
algorithmFactory, configParser, stats, statsResultConsumer, stream, streamResultConsumer, write, writeResultConsumer

Methods inherited from class org.neo4j.gds.AlgoBaseProc
compute, compute, computeEstimate, name, newConfigFunction, nodeProperties, validationConfig, validator

Methods inherited from class org.neo4j.gds.BaseProc
allocationTracker, databaseId, executionContext, graphLoaderContext, graphStoreFromCatalog, isGdsAdmin, memoryUsageValidator, runWithExceptionLogging, runWithExceptionLogging, username, validateConfig, validateConfig, validateGraphName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.neo4j.gds.executor.AlgorithmSpec
computationResultConsumer

- Field Detail
  - DESCRIPTION
```
protected static final java.lang.String DESCRIPTION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CosineProc
```
public CosineProc()
```
- Method Detail
  - newConfig
```
protected org.neo4j.gds.impl.similarity.CosineConfig newConfig(java.lang.String username,
                                                               org.neo4j.gds.core.CypherMapWrapper userInput)
```
    Specified by:
    
    newConfig in class org.neo4j.gds.AlgoBaseProc<org.neo4j.gds.impl.similarity.CosineAlgorithm,org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,org.neo4j.gds.impl.similarity.CosineConfig,PROC_RESULT>
  - newAlgo
```
protected org.neo4j.gds.impl.similarity.CosineAlgorithm newAlgo(org.neo4j.gds.impl.similarity.CosineConfig config,
                                                                org.neo4j.gds.core.utils.mem.AllocationTracker allocationTracker)
```
    Specified by:
    
    newAlgo in class AlphaSimilarityProc<org.neo4j.gds.impl.similarity.CosineAlgorithm,org.neo4j.gds.impl.similarity.CosineConfig,PROC_RESULT>
  - taskName
```
protected java.lang.String taskName()
```
    Specified by:
    
    taskName in class AlphaSimilarityProc<org.neo4j.gds.impl.similarity.CosineAlgorithm,org.neo4j.gds.impl.similarity.CosineConfig,PROC_RESULT>