add documentation for fuzzy methods

jbytecode · jbytecode · commit f04c708caa6a · 2025-04-17T20:52:29.000+03:00
diff --git a/docs/src/fuzzy.md b/docs/src/fuzzy.md
@@ -1,6 +1,26 @@
 # Fuzzy Methods 
 
+## Fuzzy Cocoso
+```@docs
+JMcDM.Fuzzy.fuzzycocoso
+```
+
 ## Fuzzy Edas 
 ```@docs
-JMcDM.Fuzzy.FuzzyEdas
+JMcDM.Fuzzy.fuzzyedas
+```
+
+## Fuzzy SAW
+```@docs
+JMcDM.Fuzzy.fuzzysaw
+```
+
+## Fuzzy Topsis
+```@docs
+JMcDM.Fuzzy.fuzzytopsis
+```
+
+## Fuzzy VIKOR
+```@docs
+JMcDM.Fuzzy.fuzzyvikor
 ```
diff --git a/src/fuzzy/cocoso.jl b/src/fuzzy/cocoso.jl
@@ -71,7 +71,28 @@ end
 
 
 
-
+"""
+    FuzzyCocoso(
+        decmat::Matrix{FuzzyType},
+        w::Vector{FuzzyType},
+        fns;
+        defuzzificationmethod::DefuzzificationMethod = WeightedMaximum(0.5),
+        lambda::Float64 = 0.5,
+    ) -> FuzzyCocosoResult where {FuzzyType<:FuzzyNumber}
+
+    Perform the fuzzy COCOSO method.
+
+# Arguments
+
+- `decmat`: The decision matrix.
+- `w`: The weights of the criteria.
+- `fns`: The direction of the criteria (maximum or minimum).
+- `defuzzificationmethod`: The defuzzification method to use.
+- `lambda`: The lambda parameter for the method.
+
+# Returns
+- `FuzzyCocosoResult`: A struct containing the results of the fuzzy COCOSO method.
+"""
 function fuzzycocoso(
     decmat::Matrix{FuzzyType},
     w::Vector{FuzzyType},
diff --git a/src/fuzzy/saw.jl b/src/fuzzy/saw.jl
@@ -6,6 +6,23 @@ struct FuzzySawResult
 end
 
 
+
+"""
+    fuzzysaw(decmat::Matrix{FuzzyType}, w::Vector{FuzzyType}, fns; defuzzificationmethod::DefuzzificationMethod = WeightedMaximum(0.5))
+
+# Description 
+
+    Fuzzy SAW method for fuzzy decision making.
+
+# Arguments
+- `decmat`: A matrix of fuzzy numbers.
+- `w`: A vector of weights.
+- `fns`: A vector of functions (either maximum or minimum).
+- `defuzzificationmethod`: The method used for defuzzification.
+
+# Returns
+- A FuzzySawResult object containing the normalized decision matrix, weighted normalized decision matrix, and scores.
+"""
 function fuzzysaw(
     decmat::Matrix{FuzzyType},
     w::Vector{FuzzyType},
diff --git a/src/fuzzy/topsis.jl b/src/fuzzy/topsis.jl
@@ -10,6 +10,24 @@ struct FuzzyTopsisResult
 end
 
 
+
+"""
+    fuzzytopsis(
+        decmat::Matrix{FuzzyType},
+        w::Vector{FuzzyType},
+        fns,
+    )::FuzzyTopsisResult where {FuzzyType<:FuzzyNumber}
+
+Fuzzy TOPSIS method for multi-criteria decision making.
+
+# Arguments
+- `decmat`: The decision matrix.
+- `w`: The weights of the criteria.
+- `fns`: The direction of the criteria (maximum or minimum).
+
+# Returns
+- `FuzzyTopsisResult`: A struct containing the results of the fuzzy TOPSIS method.
+"""
 function fuzzytopsis(
     decmat::Matrix{FuzzyType},
     w::Vector{FuzzyType},
diff --git a/src/fuzzy/vikor.jl b/src/fuzzy/vikor.jl
@@ -5,6 +5,21 @@ struct FuzzyVikorResult
 end
 
 
+"""
+    fuzzyvikor(decmat::Matrix{Triangular}, w::Vector{Triangular}, fns::Vector{F}) -> FuzzyVikorResult
+
+# Description 
+
+The fuzzy VIKOR method is a multi-criteria decision-making method that uses fuzzy logic to evaluate alternatives based on multiple criteria.
+
+# Arguments
+- `decmat::Matrix{Triangular}`: A matrix of fuzzy numbers representing the decision matrix.
+- `w::Vector{Triangular}`: A vector of fuzzy numbers representing the weights of the criteria.
+- `fns::Vector{F}`: A vector of functions (either `maximum` or `minimum`) representing the type of each criterion.
+
+# Returns
+- `FuzzyVikorResult`: A struct containing the results of the fuzzy VIKOR method, including the positive ideal solution, negative ideal solution, and the Si values for each alternative.
+"""
 function fuzzyvikor(decmat::Matrix{Triangular},
     w::Vector{Triangular},
     fns::Vector{F})::FuzzyVikorResult where {F<:Function}
