Skip to content

Repository files navigation

Corpus

Video Lectures

For Developers

You can also see Java, C, Python, Cython, C#, Js, Php, or C++ repository.

Requirements

  • Xcode Editor
  • Git

Git

Install the latest version of Git.

Download Code

In order to work on code, create a fork from GitHub page. Use Git for cloning the code to your local or below line for Ubuntu:

git clone <your-fork-git-link>

A directory called Corpus-Swift will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/Corpus-Swift.git

Open project with XCode

To import projects from Git with version control:

  • XCode IDE, select Clone an Existing Project.

  • In the Import window, paste github URL.

  • Click Clone.

Result: The imported project is listed in the Project Explorer view and files are loaded.

Compile

From IDE

After being done with the downloading and opening project, select Build option from Product menu. After compilation process, user can run Corpus-Swift.

Detailed Description

Corpus

To store a corpus in memory

a = Corpus(fileName: "derlem.txt")

If this corpus is split with dots but not in sentences

init(fileName: String, sentenceSplitter: SentenceSplitter)

To eliminate the non-Turkish sentences from the corpus

init(fileName: String, languageChecker: LanguageChecker)

The number of sentences in the corpus

func sentenceCount() -> Int

To get ith sentence in the corpus

func getSentence(index: Int) -> Sentence

TurkishSplitter

TurkishSplitter class is used to split the text into sentences in accordance with the . rules of Turkish.

func split(line: String) -> [Sentence]

For Contibutors

Package.swift file

  1. Dependencies should be given w.r.t github.
    dependencies: [
        .package(name: "MorphologicalAnalysis", url: "https://github.com/StarlangSoftware/TurkishMorphologicalAnalysis-Swift.git", .exact("1.0.6"))],
  1. Targets should include direct dependencies, files to be excluded, and all resources.
    targets: [
        .target(
	dependencies: ["MorphologicalAnalysis"],
	exclude: ["turkish1944_dictionary.txt", "turkish1944_wordnet.xml",
	"turkish1955_dictionary.txt", "turkish1955_wordnet.xml",
	"turkish1959_dictionary.txt", "turkish1959_wordnet.xml",
	"turkish1966_dictionary.txt", "turkish1966_wordnet.xml",
	"turkish1969_dictionary.txt", "turkish1969_wordnet.xml",
	"turkish1974_dictionary.txt", "turkish1974_wordnet.xml",
	"turkish1983_dictionary.txt", "turkish1983_wordnet.xml",
	"turkish1988_dictionary.txt", "turkish1988_wordnet.xml",
	"turkish1998_dictionary.txt", "turkish1998_wordnet.xml"],
	resources:
[.process("turkish_wordnet.xml"),.process("english_wordnet_version_31.xml"),.process("english_exception.xml")]),
  1. Test targets should include test directory.
	.testTarget(
		name: "WordNetTests",
		dependencies: ["WordNet"]),

Data files

  1. Add data files to the project folder.

Swift files

  1. Do not forget to comment each function.
   /**
     * Returns the value to which the specified key is mapped.
     - Parameters:
        - id: String id of a key
     - Returns: value of the specified key
     */
    public func singleMap(id: String) -> String{
        return map[id]!
    }
  1. Do not forget to define classes as open in order to be able to extend them in other packages.
	open class Word : Comparable, Equatable, Hashable
  1. Function names should follow caml case.
	public func map(id: String)->String?
  1. Write getter and setter methods.
	public func getSynSetId() -> String{
	public func setOrigin(origin: String){
  1. Use separate test class extending XCTestCase for testing purposes.
final class WordNetTest: XCTestCase {
    var turkish : WordNet = WordNet()
    
    func testSize() {
        XCTAssertEqual(78326, turkish.size())
    }
  1. Enumerated types should be declared as enum.
public enum CategoryType : String{
    case MATHEMATICS
    case SPORT
    case MUSIC
  1. Implement == operator and hasher method for hashing purposes.
    public func hash(into hasher: inout Hasher) {
        hasher.combine(name)
    }
    public static func == (lhs: Relation, rhs: Relation) -> Bool {
        return lhs.name == rhs.name
    }
  1. Make classes Comparable for comparison, Equatable for equality, and Hashable for hashing check.
	open class Word : Comparable, Equatable, Hashable
  1. Implement < operator for comparison purposes.
    public static func < (lhs: Word, rhs: Word) -> Bool {
        return lhs.name < rhs.name
    }
  1. Implement description for toString method.
	open func description() -> String{
  1. Use Bundle and XMLParserDelegate for parsing Xml files.
	let url = Bundle.module.url(forResource: fileName, withExtension: "xml")
	var parser : XMLParser = XMLParser(contentsOf: url!)!
	parser.delegate = self
	parser.parse()

also use parser method.

public func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String])